17. Custom Integration

NoahFace Visitor Registration can also support integration with 3rd party systems. For example, you may want to:

• Integrate a breath testing device into your visitor registration process.
• Record visitor details in a 3rd party Access Control system.

‍

Visitors will see a screen such as the following while the integration is being executed:

‍

NoahFace Visitor Registration will wait for your integration to complete. This allows you to return data that is stored with the event, so it can be viewed through the NoahFace Dashboard. It also allows you to return messages that are displayed on screen.

To enable an integration, specify an API endpoint as any valid URL. For example:

‍

api=192.168.1.100/breathtest

‍

Your API should return:

• An HTTP status of 200 on success, and 403 if access is denied.
• Data to be recorded in the HTTP response body.
• Messages in the HTTP header attribute: X-NOAHFACE-MESSAGE.

‍

You can pass BASIC or TOKEN credentials in your URL using syntax such as:

‍

api=user:password@192.168.1.100/breathtest

api=token@192.168.1.100/breathtest

‍

The displayed message can be configured as follows:

‍

apimsg=To complete your sign in, please conduct a breath test.

‍

The button text can be configured as follows:

‍

apiin=Done

‍

You can configure which users the API is called for by specifying one of the following:

‍

apiusers=visitors

apiusers=staff

apiusers=all

‍

By default, when the API returns, the sign on process is automatically completed. If you want users to have to manually complete their sign in, you can specify:

‍

apimode=man

‍

If you want to stop users from being able to complete their sign in on errors, specify:

‍

apimode=deny

‍

Finally, you can configure how long (in seconds) NoahFace waits for the API to return before timing out. For example:

‍

apitime=30

‍

The default timeout is 600 seconds (ie: 10 minutes).

‍

Your API will be passed the following query parameters:

‍