Übersicht

Zugang zur API

Für die Nutzung der API ist mindestens ein gültiger API-Schlüssel erforderlich (Hauptschlüssel). Dieser kann über das zuständige Teilnehmermanagement bezogen werden. Abhängig vom Anwendungsfall können zusätzlich weitere Schlüssel zur Verfügung gestellt werden. Die Verwendung und Funktion der einzelnen Schlüssel wird im weiteren Verlauf dieser Dokumentation erläutert. Kann die Authentifizierung nicht erfolgreich durchgeführt werden kommt es zu einem HTTP 401 Fehler.

Zusätzlich kann der Zugriff auf die API über eine IP-Filterung eingeschränkt werden. Es wird empfohlen, die IP-Adresse(n) der anfragenden Server (inkl. Testumgebungen) im Vorfeld zu definieren und bereitzuhalten. Schlägt die Prüfung der IP Adresse fehl, kommt es zu einem HTTP 401 Fehler.

Die API verwendet JSON (JavaScript Object Notation) als Austauschformat. Anfragen an die API sowie die von ihr zurückgegebenen Antworten müssen im JSON-Format strukturiert bzw. verarbeitet werden.

API-Endpunkte

Die API bietet drei dedizierte Endpunkte zur Interaktion:

• https://gwatch.events/ext-api/metadata
  Zweck: Abfrage verfügbarer Metadaten und Konfigurationsinformationen.
• https://gwatch.events/ext-api/pull
  Zweck: Abruf vorhandener Gast-Daten.
• https://gwatch.events/ext-api/push
  Zweck: Übertragung (Hinzufügen oder Aktualisieren) von Gast-Daten.

Weitere Informationen

Die genaue Struktur der Anfragen, das erwartete JSON-Format sowie mögliche Fehlermeldungen und Antwort-Codes werden auf den folgenden Seiten ausführlich beschrieben.

Falls Sie die API online testen möchten, so können Sie dies möglich unter der Adresse:
https://gwatch.events/ext-api