Our Open APIs (REST Web Hooks) allow you to integrate NoahFace with your existing IT systems and applications. For example, you could:
The opportunities are endless.
NoahFace can automatically retrieve your list of users from an existing IT system so you don't need to import/export users or manually maintain them in two places. To do this, you simply implement our User Synchronisation API (a REST Web Hook), and configure NoahFace to call it.
Your implementation of the User Synchronisation API should return JSON data. The JSON data should contain a single element called Users, which is an array of all of your users. Each user can contain any of the following elements:
Only the SyncGuid and at least one of the Name and FirstName elements are mandatory for each user.
The following is an example of the JSON that your API should return.
To enable user synchronisation, simply add a synchronisation instance, select 'Custom' as the type of synchronisation, and specifying your API endpoint details (see example below).
Your API should return an HTTP response code of 200 on success, and an appropriate response code on failure (eg: 404 if the specified User list url is incorrect, 401 if access was unauthorised, etc).
NoahFace can forward user events to your applications or IT systems. To do this, you simply implement our Event Notification API (a REST Web Hook), and configure NoahFace to call it when a user records an event.
Your implementation of the Event Notification API should expect to receive the following elements:
The full list of possible event types is as follows:
Your API can be designed to be called using an HTTP GET, PUT, or POST method. If you use GET, the event data will be sent in query parameters. If you specify PUT or POST, the event data will be sent in JSON format (see example below).
The following is an example of the JSON that your API should expect. All elements will be present even if they are empty.
To forward user events, simply add a notification, select 'Custom' as the type, and specifying your API endpoint details (see example below). Once you have done this, associated this notification with an access point type, and create your access point.
Your API should return an HTTP response code of 200 on success, and an appropriate response code on failure (eg: 404 if the specified Notification url is incorrect, 401 if access was unauthorised, etc). If you return anything other than 200, then NoahFace will attempt to re-send the event the following number of hours in the future:
2 ^ (number of failed attempts - 1)
So, the first retry will be after 1 hour, the second retry will be after an additional 2 hours, the third retry will be after an additional 4 hours, etc. This will continue until your API returns success, or until 90 days has passed.
Your implementation of the NoahFace APIs should enforce one of the following authentication methods:
If your implementation of the NoahFace APIs is being designed to service multiple organisations, you should use different credentials for each organisation so you can access the appropriate data in your IT system or application.
Regardless of which authentication method you choose, all API calls are over SSL so your data and credentials are encrypted.