Getting started
Documentation destinée aux partenaires désirant faire le pont entre leur application et le Nexus de Logifox Technologies inc.
Veuillez vous référer à ce document en tout temps afin d’être assuré d’obtenir la plus récente version des spécifications. Tous changements effectués aux spécifications vous seront communiqués à l’avance pour éviter les risques d’incompatibilités.
Le pont se fera par l’entremise d’une communication direct à la passerelle pour une interaction simple et sécurisée.
Choisissez d'abord le niveau d'intégration qui correspond à vos besoins
About the Application ID
While testing in the sandbox environement, you can use "ae112c81-1faa-45bf-81e9-aa7207b4c6a5" as application ID. This ID is ONLY valid on the sandbox environement.
On production environement, YOU MUST ABSOLUTELY use your application ID.
Select an application
Access point
Le point d’accès principal ( ) est disponible dans la section Configuration du Nexus, sous l’onglet Passerelle.
L’utilisateur peut copier ce lien en cliquant sur le bouton .
Ce point d’accès devrait avoir la forme suivante: https://nom_du_client.nexus.logifox.io/bridge
Les paramètres sont toujours transmis selon le format JSON
Authentification
En plus du PAP, vous devez obtenir un jeton d’authentification. Ce jeton est unique au client et assure la sécurisation des données. Il est recommandé de renouveler ce jeton quotidiennement.
Les appels suivants se feront en ajoutant un attribut auth_token à l’entête des requêtes avec la valeur du jeton.
Bridge information
This endpoint returns some basic numbers for clients.
Clients synchronisation
These endpoint are use to synchronize clients' informations between your application and the Nexus.
Users synchronisation
These endpoint are use to synchronize users' informations between your application and the Nexus.
Services synchronisation
These endpoint are use to synchronize services' informations between your application and the Nexus.
Rooms synchronisation
These endpoint are use to synchronize rooms' informations between your application and the Nexus.
Person flows synchronisation
These endpoint are use to synchronize person flow's informations between your application and the Nexus.
Data type definitions
Webhooks
To receive informations from the Nexus, you must expose webhooks. Since webhooks are called from client application, local addresses will work.
Use the following tool to test and validate data. When you're ready, check the hook(s) you want to integrate to your app and click que "Submit" button to send the configurations to Logifox.
You must supply a JSON object as return value of any webhooks. A successful call JSON object must fit the following form:
{
result: "success"
data: {...}
error: ""
}
The "error" attribute is optional and should be use when "result" equal "fail". You can add any other attributes.
The "data" attribute is a container for any information that you send back to the Nexus from action webhooks.