Sign In App Documentation

Résumé

Cette API est conçue pour vous aider à étendre votre expérience Sign In App pour y inclure des tableaux de bord personnalisés, des informations commerciales et l'intégration avec des applications tierces.

Tous les points d'extrémité de l'API sont protégés et les appels doivent être authentifiés à l'aide de la méthode décrite ici.

Prérequis

• Un compte sur my.signinapp.com (appelé le portail). Des comptes d'essai peuvent être créés ici.
• Un client API sur portal avec une key et un secret utilisés pour s'authentifier avec l'API. Les instructions pour configurer un client API peuvent être trouvées ici.
• Langage de programmation permettant d'effectuer des requêtes web (GET) et de modifier les en-têtes HTTP.

URI de base

L'URI de base à appeler peut être trouvé dans les détails lors de la gestion d'un client API dans le portail. Chaque endpoint est spécifique à l'espace client dans lequel le client est créé. L'hôte ressemblera à backend.region-x.signinapp.com et l'URI de base ressemblera à https://<base-url>/client-api/v1.

Données de requête / de réponse

Sauf indication contraire, tous les endpoints reçoivent et renvoient des données JSON.

Content-Type: application/json

Problèmes courants et solutions

Lors d'une requête, le endpoint renvoie le statut HTTP 302.

C'est généralement parce que tous les endpoints requièrent que les en-têtes Content-Type et Accept soient mis à application/json. Définir ces en-têtes sur toutes les requêtes devrait produire le comportement attendu.

Réception de 404 sur un endpoint qui a fonctionné avec des paramètres différents.

Cela peut être dû à la spécification de paramètres de requête incorrects. Lorsque l'on spécifie des ID sur des ressources qui n'existent pas les endpoints renvoient un message 404. Vérifiez que les identifiants spécifiés sont corrects.

Structure de l'application et termes utilisés

Les paragraphes suivants décrivent les différents termes utilisés et leurs relations au sein de Sign In App.

• 'Client': Il s'agit de votre compte. Tous les utilisateurs du portail et les clients de l'API sont liés à un client.
• 'Site'. Un site peut être considéré comme l'emplacement d'un bureau. Plusieurs sites peuvent appartenir à un même client.
• 'Remote Site'. Il s'agit d'un type spécial de site qui représente les visiteurs qui s'enregistrent à distance. Un client possède un site distant.
• 'Device'. Un appareil est la tablette physique qui exécute Sign In App et sur laquelle les visiteurs enregistrent leur entrée. Zéro ou plusieurs appareils peuvent être connectés à un site.
• 'Mobile Device'. Un appareil mobile est le mobile d'un visiteur qui revient. Un seul appareil mobile est connecté à un visiteur qui revient.
• 'Visitor Group'. Un groupe de visiteurs peut être un groupe de visiteurs ou de visiteurs qui reviennent. Un client peut avoir plusieurs groupes de visiteurs.
• 'Visitor'. Un visiteur est une personne qui enregistre son entrée sur le site. Un visiteur est une personne qui enregistre son entrée dans un groupe sur l'application, mais qui peut ne pas revenir. Il peut y avoir plusieurs visiteurs dans un groupe.
• 'Returning Visitor'. Les visiteurs qui reviennent sont des personnes connues du client qui reviennent régulièrement. Il peut y avoir plusieurs visiteurs qui reviennent dans un groupe.