Sign In App Documentation

Zusammenfassung

Diese API soll Ihnen helfen, Ihr Sign In App-Erlebnis um personalisierte Dashboards, Geschäftsinformationen und die Integration mit Anwendungen von Drittanbietern zu erweitern.

Alle API-Endpunkte sind geschützt und die Aufrufe müssen mit der hier beschriebenen Methode authentifiziert werden.

Voraussetzungen

• Ein Konto auf my.signinapp.com (genannt Portal). Testkonten können hier erstellt werden.
• Ein API-Client auf dem Portal mit einem key und einem secret, die zur Authentifizierung bei der API verwendet werden. Anweisungen zum Einrichten einer Client-API finden Sie hier.
• Programmiersprache mit der Fähigkeit, Webanfragen (GET) durchzuführen und HTTP- Kopfzeilen zu ändern.

Basis-URI

Die aufzurufende Basis-URI kann als Teil der Details bei der Verwaltung eines API-Clients im Portal gefunden werden. Jeder endpoint ist spezifisch für den Client-Bereich, in dem der Client erstellt wird. Der Host sieht aus wie backend.region-x.signinapp.com. und die Basis-URI wird https://<base-url>/client-api/v1 sein.

Anfrage/Antwort-Daten

Wenn nicht anders angegeben, empfangen und geben alle Endpunkte JSON-Daten zurück.

Content-Type: application/json

Allgemeine Probleme und Lösungen

Wenn eine Anfrage gestellt wird, gibt der endpoint den HTTP-Status 302 zurück.

Dies liegt normalerweise daran, dass für alle endpoints die Header Content-Type und Accept auf application/json gesetzt werden müssen. Das Festlegen dieser Header für alle Anfragen sollte das erwartete Verhalten bewirken.

Empfang von 404 auf einem endpoint, der mit anderen Parametern gearbeitet hat.

Dies kann darauf zurückzuführen sein, dass falsche Anfrageparameter angegeben wurden. Wenn IDs für Ressourcen angegeben werden, die nicht existieren endpoints gibt eine 404 zurück. Überprüfen Sie, ob die angegebenen IDs korrekt sind.

Struktur und Bedingungen des Antrags

Nachfolgend finden Sie eine Beschreibung der verschiedenen Begriffe und ihrer Beziehungen innerhalb der Sign In App.

• 'Client': ist Ihr Konto. Alle Portalnutzer und API- Kunden sind mit einem Kunden verbunden.
• 'Site'. Ein Standort kann als der Standort eines Büros betrachtet werden. Einem Kunden können mehrere Standorte gehören.
• 'Remote Site'. Dies ist eine besondere Art von Standort, der Besucher repräsentiert, die sich aus der Ferne anmelden. Ein Kunde hat einen Remote-Standort.
• 'Device'. Ein Gerät ist das materielle Tablet, auf dem die Sign-In-App läuft und auf dem sich die Besucher anmelden. Es können null oder mehr Geräte mit einem Standort verbunden sein.
• 'Mobile Device'. Ein mobiles Gerät ist das Handy eines wiederkehrenden Besuchers. Ein mobiles Gerät ist mit einem wiederkehrenden Besucher verbunden.
• 'Visitor Group'. Eine Besuchergruppe kann eine Gruppe von Besuchern oder eine Gruppe von wiederkehrenden Besuchern sein. Ein Kunde kann viele Besuchergruppen haben.
• 'Visitor'. Ein Besucher ist eine Person, die sich in der Anwendung für eine Gruppe anmeldet, aber möglicherweise nicht zurückkehrt. Es kann viele Besucher in einer Gruppe geben.
• 'Returning Visitor'. Wiederkehrende Besucher sind Personen, die dem Kunden bekannt sind und ihn wiederholt besuchen. In einer Gruppe kann es viele wiederkehrende Besucher geben.