Sign In App Documentation
Endpoint Ressourcen
Gruppen
Der Gruupen endpoint ermöglicht es Ihnen, eine Liste Ihrer Gruppen zusammen mit der Gruppen-ID, dem Gruppennamen und dem Gruppentyp zurückzugeben.
GET client-api/v1/groups
Anfrage
Es gibt keine zusätzlichen Parameter.
Antwort
Schema
Root Array.
| Key | Type | Description |
|---|---|---|
id | String | Die ID der Besuchergruppe. |
name | String | Der Name der Besuchergruppe. |
type | String | Der Typ der Besuchergruppe. |
[
{
"id": 1,
"name": "Visitors",
"type": "non-returning"
},
{
"id": 2,
"name": "Employees",
"type": "returning"
},
{
"id": 3,
"name": "Deliveries",
"type": "delivery"
}
]
Fehler
Für diese Ressource gibt es keine Parameter, daher beschränken sich die Fehler auf interne Serverfehler oder nicht gefundene Fehler (404).
Gruppen / Mitglieder
Der endpoint Gruppenmitglieder ermöglicht es Ihnen, eine Liste der wiederkehrenden Besucher einer bestimmten Gruppe zu erhalten. Die Daten sind paginiert und umfassen maximal 200 Mitglieder pro Seite. Jedes Mitglied beschreibt Schlüsselinformationen wie persönliche Felder, Berechtigungen, letzte Ein- und Ausgänge und mehr.
Um die Gruppenbezeichnung zu finden, gehen Sie zu https://my.signinapp.com/manage und klicken Sie auf die Gruppe, für die Sie Daten anfordern möchten. Die Gruppenbezeichnung wird in der URL nach /group angezeigt.
GET client-api/v1/groups/<group_id>/members
Anfrage
Keine zusätzlichen Parameter.
Antwort
Die vom Gruppenmitglied- Endpoint zurückgegebene Antwort ist paginiert. Verwenden Sie links.next, um weitere Seiten mit Daten anzufordern. Auf der letzten Seite wird links.next den Wert null haben.
Schema
Root Object
| Key | Typ | Description |
|---|---|---|
links | Object | Key |
meta | Object | |
data | Array | Eine Liste von Ressourcen von wiederkehrenden Besuchern. |
Links Object.
Links zur Paginierung.
| Key | Type | Description |
|---|---|---|
first | String | URL der ersten Seite. |
last | String | URL der letzten Seite. |
prev | String Null | URL der vorherigen Seite. |
next | String Null | URL der nächsten Seite. |
Meta Object
| Key | Typ | Beschreibung |
|---|---|---|
current_page | Number | Die Nummer der aktuell aufgerufenen Seite. |
from | Number | Ab der Datensatzposition. |
path | String | Angeforderte URL. |
per_page | Number | Anzahl der zurückgegebenen Datensätze pro Seite. |
to | Number | Bis zur Datensatzposition. |
Beispiel
{
"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
}
},
{
"..."
}
]
}
Fehler
Neben internen Serverfehlern sind die folgenden Antworttypen wahrscheinlich.
| Code | Beschreibung |
|---|---|
| 404 | Die angegebene Ressource oder einer der Parameter existiert nicht. Überprüfen Sie die Gruppen-ID. |
| 422 | Es ist ein Validierungsfehler aufgetreten. Die ausgewählte Gruppe ist wahrscheinlich nicht vom Rückgabetyp. |
Standorte / Historie
Mit dem endpoint Geschichte können Sie Ihre eigenen Berichte für jeden Standort erstellen und automatisieren. Durch Angabe eines Start- und Enddatums mit einem maximalen Intervall von 92 Tagen können Sie alle ein- und ausgehenden Aktivitäten für Standardbesucher und wiederholte Besucher, wie z. B. Mitarbeiter, abfragen. Wenn Sie möchten, können Sie diese Ergebnisse nach Gruppen oder nach einem bestimmten Gruppenmitglied filtern.
Um Ihre Standortkennung zu finden, gehen Sie zu https://my.signinapp.com/manage und klicken Sie auf den Standort, für den Sie Daten abfragen möchten. Die Standortkennung erscheint in der URL nach /site.
GET client-api/v1/sites/<site_id>/history
Anwendung
| Key | Type | Required | Description |
|---|---|---|---|
| date_from | String | true | Das Datum, ab dem die Historie durchsucht werden soll. Das erwartete Format ist ISO-8601. |
| date_to | String | true | Das Datum, bis zu dem die Historie durchsucht werden soll. Das erwartete Format ist ISO-8601. |
| group_id | Number | false | Die ID einer Besuchergruppe, nach der die Historie gefiltert werden soll. |
| returning_visitor_id | Number | false | Die ID eines wiederkehrenden Besuchers, nach dem die Historie gefiltert werden soll. |
Datumsbereich
Der Datumsbereich für den Verlaufsendpunkt bis zu einem Maximum von 92 Tagen.
Antwort
Die vom History-Endpunkt zurückgegebene Antwort ist paginiert. Verwenden Sie links.next, um die nächsten Seiten der Daten anzufordern. Auf der letzten Seite wird links.next einen null Wert haben.
Root Object
| Key | Typ | Description |
|---|---|---|
links | Object | Schlüsselwerte von Links zu anderen historischen Seitenergebnissen für diese Abfrage. |
meta | Object | Informationen über die Ergebnismenge. |
data | Array | Eine Liste von [Besucherressourcen] (/client-api/resources.md#visitor-resource). |
Links Object
Paginierungs-Links.
| Key | Typ | Description |
|---|---|---|
first | String | URL der ersten Seite. |
last | Null | URL der letzten Seite. Wird nicht verwendet und ist immer null. |
prev | String Null | URL der vorherigen Seite. |
next | String Null | URL der nächsten Seite. |
Meta Object
| Key | Typ | Description |
|---|---|---|
current_page | Number | Die Nummer der aktuell aufgerufenen Seite. |
from | Number | Ab der Datensatzposition. |
path | String | URL der Anfrage. |
per_page | Number | Anzahl der zurückgegebenen Datensätze pro Seite. |
to | Number | Bis zur Datensatzposition. |
{
"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": []
},
{
"..."
}
]
}
Fehler
Neben internen Serverfehlern sind die folgenden Antworttypen wahrscheinlich.
| Code | Description |
|---|---|
| 404 | Entweder existiert die angegebene Ressource oder einer der Parameter nicht. |
| 422 | Ein Validierungsfehler ist aufgetreten. Überprüfen Sie den eingegebenen Wert anhand der Beschreibung der Anfrageparameter. |
Standorte / Heute
Mit dem Endpoint Heute können Sie eine Live-Ansicht der Personen erstellen, die sich bei Ihrer Website angemeldet haben. Er gibt auch eine Liste der vorangemeldeten Gäste zurück. Die Anmeldeaktivitäten werden gruppiert, so dass es einfach ist, ein Dashboard für eine bestimmte Besuchergruppe zu erstellen, bevorstehende Besucher anzuzeigen oder die jüngste Anmeldung auf Ihrer digitalen Beschilderung hervorzuheben.
Um Ihre Standort-ID zu finden, gehen Sie zu https://my.signinapp.com/manage und klicken Sie auf den Standort, für den Sie Daten anfordern möchten. Die Standort-ID wird in der URL nach „/site“ angezeigt.
GET client-api/v1/sites/<site_id>/today
Anfrage
Keine obligatorischen oder optionalen Parameter.
Antwort
Schema
Root Array. Eine Liste von Gruppenressourcen.
[
{"..."},
{"..."}
]
[{
"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"
}
}
]
}]
Fehler
Für diese Ressource gibt es keine Parameter, daher beschränken sich die Fehler auf interne Serverfehler oder nicht gefundene Fehler (404).
Spaces / Buchungen
Mit dem Spaces- Endpoint können Sie Ihre eigenen Berichte für Spaces-Reservierungen erstellen. Durch die Angabe eines Start- und eines Enddatums, die nicht mehr als 60 Tage auseinander liegen, können Sie alle Buchungen während dieses Zeitraums abfragen. Diese Ergebnisse können nach Raum, Zone und Kategorie gefiltert werden.
Um die Standortkennung zu finden, gehen Sie zu https://my.signinapp.com/manage und klicken Sie auf den Standort, für den Sie Daten abfragen möchten. Die Standortkennung wird in der URL nach /site angezeigt.
GET client-api/v1/spaces/<site_id>/bookings
Anfrage
| Key | Type | Required | Description |
|---|---|---|---|
| filter[date_between] | String | true | Der Datumsbereich, zwischen dem nach Reservierungen gesucht werden soll. Das erwartete Format ist ISO-8601. |
| filter[site_id] | Number | true | Die ID des Standorts, nach dem der Verlauf gefiltert werden soll. |
| filter[returning_visitor_id] | Number | false | Die ID eines wiederkehrenden Besuchers, nach dem der Verlauf gefiltert werden soll. |
| filter[space_id] | String | false | Die String-ID eines bestimmten Bereichs. |
| filter[zone_id] | String | false | Die String-ID einer bestimmten Zone. |
Filter
Mit dem Spaces Buchung Endpoint müssen Sie die Option Filter verwenden, um den Zeitrahmen des API-Aufrufs festzulegen oder um mit zusätzlichen Parametern zu filtern. Das Format hierfür ist ?filter[] für den ersten Filter und dann &filter[] für alle weiteren Filter. Der obige Abfragekey steht innerhalb der eckigen Klammern. Zum Beispiel:
?filter[date_between]=2023-05-01,2023-05-31&filter[returning_visitor_id]=6462197
Diese Anfrage würde Reservierungen vom 1. Mai 2023 bis zum 31. Mai 2023 für die Besucher-ID 6462197 zurückgeben.
Standort der Raum- und Zonen-IDs
Wenn Sie die Raum- oder Zonen-IDs in Ihren API-Aufruf einbeziehen möchten, können Sie sie im Sign In App portal finden. Klicken Sie auf die Registerkarte Spaces und wählen Sie den Raum oder die Zone aus der Liste auf der linken Seite des Bildschirms. Die Raum- oder Zonen-ID ist der alphanumerische Wert am Ende der URL.
Antwort
Die vom Spaces- Endpoint zurückgegebene Antwort ist paginiert. Verwenden Sie links.next, um nachfolgende Datenseiten anzufordern. Auf der letzten Seite hat links.next einen Nullwert.
Schema
Root Object
| Key | Type | Description |
|---|---|---|
links | Object | Schlüsselwerte von Links zu anderen historischen Seitenergebnissen für diese Abfrage. |
meta | Object | |
data | Array | Eine Liste von [Besucherressourcen] (/client-api/resources.md#visitor-resource). |
Links Object
Paginierungs-Links.
| Key | Typ | Description |
|---|---|---|
first | String | URL der ersten Seite. |
last | Null | URL der letzten Seite. Wird nicht verwendet und ist immer null. |
prev | String Null | URL der vorherigen Seite. |
next | String Null | URL der nächsten Seite. |
Meta Object
| Key | Typ | Description |
|---|---|---|
current_page | Number | |
from | Number | Ab der Datensatzposition. |
path | String | URL der Anfrage. |
per_page | Number | Anzahl der zurückgegebenen Datensätze pro Seite. |
to | Number | Bis zur Datensatzposition. |
Beispiel
{
"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
}
Fehler
| Code | Description |
|---|---|
| 404 | Die angegebene Ressource oder einer der Parameter ist nicht vorhanden. Überprüfen Sie die Gruppen-ID. |
| 422 | Es ist ein Validierungsfehler aufgetreten. Es ist wahrscheinlich, dass die ausgewählte Gruppe nicht vom Rückgabetyp ist. |