Sign In App Documentation
Ressources de endpoints
Groupes
Le endpoint de groupe vous permet de renvoyer une liste de vos groupes avec l'ID du groupe, le nom et le type de groupe.
GET client-api/v1/groups
Requête
Il n'y a pas de paramètres supplémentaires.
Réponse
Schéma
RootArray.
| Key | Type | Description |
|---|---|---|
id | String | L'ID du groupe de visiteurs. |
name | String | Le nom du groupe de visiteurs. |
type | String | Le type du groupe de visiteurs. |
Exemple
[
{
"id": 1,
"name": "Visitors",
"type": "non-returning"
},
{
"id": 2,
"name": "Employees",
"type": "returning"
},
{
"id": 3,
"name": "Deliveries",
"type": "delivery"
}
]
Erreurs
Il n'y a pas de paramètres pour cette ressource, les erreurs sont donc limitées aux erreurs internes du serveur ou aux erreurs non trouvées (404).
Groupes / Membres
Le endpoint des membres d'un groupe vous permet d'obtenir une liste des visiteurs qui reviennent pour un groupe spécifique. Les données sont paginées jusqu'à 200 membres par page. Chaque membre décrit des informations clés telles que les champs personnels, les autorisations, les dernières entrées et sorties, etc.
Pour trouver l'identifiant de votre groupe, rendez-vous sur https://my.signinapp.com/manage et cliquez sur le groupe pour lequel vous souhaitez obtenir des données. L'identifiant du groupe sera visible dans l'URL après /group.
GET client-api/v1/groups/<group_id>/members
Requête
Il n'y a pas de paramètres supplémentaires.
Réponse
La réponse renvoyée par le endpoint de membres du groupe est paginée. Utilisez les links.next pour demander les pages de données suivantes. Sur la dernière page, le links.next aura une valeur null.
Schéma
Root Object
| Key | Type | Description |
|---|---|---|
links | Object | Valeurs keys des liens vers d'autres résultats historiques paginés pour cette requête. |
meta | Object | Informations sur l'ensemble des résultats. |
data | Array | Une liste de ressources de visiteurs qui reviennent. |
Links Object
Liens de pagination.
| Key | Type | Description |
|---|---|---|
first | String | URL de la première page. |
last | String | URL de la dernière page. |
prev | String Null | URL de la page précédente. |
next | String Null | URL de la page suivante. |
Meta Object
| Key | Type | Description |
|---|---|---|
current_page | Number | Le numéro de la page demandée. |
from | Number | A partir de la position de l'enregistrement. |
path | String | URL de la requête. |
per_page | Number | Nombre d'enregistrements retournés par page. |
to | Number | Position de l'enregistrement. |
Exemple
{
"links": {
"first": "https://example.signinapp.com/client-api/v1/groups/123/members?page=1",
"last": "https://example.signinapp.com/client-api/v1/groups/123/members?page=2",
"prev": null,
"next": "https://example.signinapp.com/client-api/v1/groups/123/members?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://example.signinapp.com/client-api/v1/groups/123/members",
"per_page": 200,
"to": 200
},
"data": [
{
"id": 456,
"group_id": 123,
"site_id": null,
"qr_code": null,
"personal_fields": {},
"photo_url": "https://cdn.host.net/photos/n23KjhFh3j2h42399AL.jpg",
"last_in": "2020-02-06T17:46:00Z",
"last_out": "2020-02-07T09:13:25Z",
"status": "signed_out",
"permissions": {
"can_access_firelist": true,
"can_pre_reg": false,
"can_mobile_sign_in": true,
"can_view_sign_in_history": false,
"can_auto_sign_in": false,
"can_access_today": false
}
},
{
"..."
}
]
}
Erreurs
Outre les erreurs internes du serveur, les types de réponses suivants sont probables.
| Code | Description |
|---|---|
| 404 | La ressource spécifiée ou l'un des paramètres n'existe pas. Vérifiez l'identifiant du groupe. |
| 422 | Une erreur de validation s'est produite. Il est probable que le groupe sélectionné ne soit pas de type qui revient. |
Sites / Historique
Le endpoint Historique vous permet de créer et d'automatiser vos propres rapports pour chaque site. En spécifiant une date de début et une date de fin espacées de 92 jours au maximum, vous pouvez demander toutes les activités d'entrée et de sortie des visiteurs standard et des visiteurs fréquents tels que le personnel. Ces résultats peuvent être filtrés par groupe ou par membre d'un groupe spécifique si nécessaire.
Pour localiser l'identifiant de votre site, rendez-vous sur https://my.signinapp.com/manage et cliquez sur le site pour lequel vous souhaitez obtenir des données. L'identifiant du site sera visible dans l'URL après /site.
GET client-api/v1/sites/<site_id>/history
Requête
| Key | Type | Required | Description |
|---|---|---|---|
| date_from | String | true | La date à partir de laquelle l'historique doit être recherché. Le format attendu est ISO-8601 |
| date_to | String | true | La date jusqu'à laquelle effectuer la recherche dans l'historique. Le format attendu est ISO-8601 |
| group_id | Number | false | L'ID d'un groupe de visiteurs par lequel filtrer l'historique. |
| returning_visitor_id | Number | false | L'ID d'un visiteur qui revient dans l'historique pour le filtrer. |
Plage de dates
La plage de dates pour le endpoint de l'historique jusqu'à un maximum de 92 jours.
Réponse
La réponse renvoyée par le endpoint de l'historique est paginée. Utilisez links.next pour demander les pages suivantes de données. Sur la dernière page, le links.next aura une valeur null.
Schéma
Root Object
| Key | Type | Description |
|---|---|---|
links | Object | Valeurs clés des liens vers d'autres résultats historiques paginés pour cette requête. |
meta | Object | Informations sur l'ensemble des résultats. |
data | Array | Une liste de [ressources visiteurs] (/client-api/resources.md#visitor-resource). |
Links Object
Liens de pagination.
| Key | Type | Description |
|---|---|---|
first | String | URL de la première page. |
last | Null | URL de la dernière page. Elle n'est pas utilisée et sera toujours nulle. |
prev | String Null | URL de la page précédente. |
next | String Null | URL de la page suivante. |
Meta Object
| Key | Type | Description |
|---|---|---|
current_page | Number | Le numéro de la page demandée. |
from | Number | A partir de la position de l'enregistrement. |
path | String | URL de la requête. |
per_page | Number | Nombre d'enregistrements renvoyés par page. |
to | Number | Jusqu'à la position de l'enregistrement. |
Exemple
{
"links": {
"first": "https://example.signinapp.com/client-api/v1/sites/123/history?date_from=2020-01-01T00%3A00%3A00&date_to=2020-02-29T23%3A59%3A59&page=1",
"last": null,
"prev": null,
"next": "https://example.signinapp.com/client-api/v1/sites/123/history?date_from=2020-01-01T00%3A00%3A00&date_to=2020-02-29T23%3A59%3A59&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://example.signinapp.com/client-api/v1/sites/123/history",
"per_page": 30,
"to": 30
},
"data": [
{
"id": 456,
"returning_visitor_id": null,
"name": "Jane Doe",
"photo_url": null,
"badge_url": null,
"status": "signed_out",
"in_datetime": "2020-02-06T17:46:00Z",
"out_datetime": "2020-02-07T09:13:25Z",
"expected_datetime": null,
"additional_fields": {
"Visiting": "John Doe"
},
"personal_fields": []
},
{
"..."
}
]
}
Erreurs
Outre les erreurs internes du serveur, les types de réponse suivants sont probables.
| Code | Description |
|---|---|
| 404 | La ressource spécifiée ou l'un des paramètres n'existe pas. |
| 422 | Une erreur de validation s'est produite. Vérifiez la valeur saisie par rapport à la description des paramètres de la demande. |
Sites / Aujourd'hui
Le endpoint d'aujourd'hui vous permet de construire une vue en direct des personnes qui ont enregistré leur entrée sur votre site. Il renvoie également une liste des invités pré-enregistrés. L'activité d'enregistrement est groupée, ce qui facilite la création d'un tableau de bord pour un groupe de visiteurs spécifique, d'afficher les visiteurs à venir ou de mettre en évidence l'enregistrement le plus récent sur votre site,
Pour trouver l'identifiant de votre site, rendez-vous sur https://my.signinapp.com/manage et cliquez sur le site pour lequel vous souhaitez obtenir des données. L'identifiant du site sera visible dans l'URL après /site.
GET client-api/v1/sites/<site_id>/today
Requête
Aucun paramètre requis ou optionnel.
Réponse
Schéma
Root Array. Une liste de ressources de groupe.
[
{"..."},
{"..."}
]
Exemple
[{
"id": 456,
"name": "Visitors",
"type": "non-returning",
"visitors": []
},
{
"id": 654,
"name": "Staff",
"type": "returning",
"visitors": [
{
"id": 789,
"returning_visitor_id": 987,
"name": "John Smith",
"photo_url": "https://example.com/path/to/image",
"badge_url": null,
"status": "signed_in",
"in_datetime": "2019-12-12T12:12:12Z",
"out_datetime": null,
"expected_datetime": null,
"additional_fields": {
"Company": "Acme Co",
"Invite Email": "john.smith@example.com"
},
"personal_fields": {
"name": "John Smith",
"email": "john.smith@example.com",
"mobile": "",
"role": "Manager"
}
}
]
}]
Erreurs
Il n'y a pas de paramètres pour cette ressource, les erreurs sont donc limitées aux erreurs internes du serveur ou aux erreurs non trouvées (404).
Spaces / Réservations
Le endpoint de Spaces vous permet de créer vos propres rapports sur les réservations de Spaces. En spécifiant une date de début et une date de fin à 60 jours d'intervalle maximum, vous pouvez demander toutes les réservations effectuées au cours de cette période. Ces résultats peuvent ensuite être filtrés par espace, zone et catégorie.
Pour trouver l'identifiant de votre site, allez sur https://my.signinapp.com/manage et cliquez sur le site pour lequel vous souhaitez demander des données. L'identifiant du site sera visible dans l'URL après /site.
GET client-api/v1/spaces/<site_id>/bookings
Requête
| Key | Type | Required | Description |
|---|---|---|---|
| filter[date_between] | String | true | La plage de dates entre lesquelles les réservations doivent être recherchées. Le format attendu est ISO-8601 |
| filter[site_id] | Number | true | L'ID du site par lequel filtrer l'historique. |
| filter[returning_visitor_id] | Number | false | L'ID d'un visiteur qui revient sur le site pour filtrer l'historique. |
| filter[space_id] | String | false | La chaîne d'identification d'un espace spécifique |
| filter[zone_id] | String | false | La chaîne d'ID d'une zone spécifique |
Filtre
Avec le endpoint de réservation Spaces, vous devez utiliser l'option Filter pour définir la période de temps de l'appel API ou pour filtrer avec des paramètres supplémentaires. Le format est ?filter[] pour le premier filtre et ensuite &filter[] pour tout filtre supplémentaire. La key de requête ci-dessus se trouve à l'intérieur des crochets. Par exemple :
?filter[date_between]=2023-05-01,2023-05-31&filter[returning_visitor_id]=6462197
Cette requête renverrait les réservations du 1er mai 2023 au 31 mai 2023 pour le visiteur dont l'ID est 6462197.
Localiser les ID d'espace et de zone
Si vous souhaitez inclure des ID d'espace ou de zone dans votre appel API, vous pouvez les trouver sur le portail Sign In App. Cliquez sur l'onglet Spaces, puis sélectionnez l'espace ou la zone dans la liste située à gauche de l'écran. L'ID de l'espace ou de la zone est la valeur alphanumérique à la fin de l'URL.
Réponse
La réponse renvoyée par le endpoint espace est paginée. Utilisez le lien links.next pour demander les pages de données suivantes. Sur la dernière page, la valeur de links.next sera nulle.
Schéma
Root Object
| Key | Type | Description |
|---|---|---|
links | Object | Valeurs clés des liens vers d'autres résultats historiques paginés pour cette requête. |
meta | Objet | Informations sur l'ensemble des résultats. |
data | Array | Une liste de [ressources visiteurs] (/client-api/resources.md#visitor-resource). |
Links Object
Liens de pagination.
| Key | Type | Description |
|---|---|---|
first | String | URL de la première page. |
last | Null | URL de la dernière page. Elle n'est pas utilisée et sera toujours nulle. |
prev | String Null | URL de la page précédente. |
next | String Null | URL de la page suivante. |
Meta Object
| Key | Type | Description |
|---|---|---|
current_page | Number | Le numéro de la page demandée. |
from | Number | A partir de la position de l'enregistrement. |
path | String | URL de la requête. |
per_page | Number | Nombre d'enregistrements renvoyés par page. |
to | Number | Jusqu'à la position de l'enregistrement. |
Exemple
{
"data": [
{
"id": 1201999,
"site_space_id": 23156,
"returning_visitor": {
"id": 2935520,
"name": "Joe Bloggs",
"photo_url": null
},
"space": {
"id": "MTHUFKkBMj",
"name": "Desk 1",
"photo": null,
"category": "desk",
"description": null,
"capacity": 1,
"zones": [
{
"name": "Floor 1"
}
]
},
"start_date": "2022-11-21T17:00:00Z",
"end_date": "2022-11-21T18:00:00Z",
"occupancy": 1,
"note": null
}
Erreurs
| Code | Description |
|---|---|
| 404 | La ressource spécifiée ou l'un des paramètres n'existe pas. Vérifier l'identifiant du groupe. |
| 422 | Une erreur de validation s'est produite. Il est probable que le groupe sélectionné ne soit pas de type qui revient. |