Übersicht

Um die API nutzen zu können, benötigen Sie mindestens einen API-Schlüssel (den sogenannten Hauptschlüssel). Diesen erhalten Sie über Ihr Teilnehmermanagement. Je nach Anwendungsfall kann es sein, dass Ihnen zusätzlich weitere Schlüssel bereitgestellt werden. Die genaue Verwendung der Schlüssel wird im weiteren Verlauf der Dokumentation erläutert.

Darüber hinaus empfehlen wir, den Zugriff auf die API über einen IP-Filter einzuschränken. Halten Sie daher idealerweise die IP-Adresse des anfragenden Servers sowie ggf. Ihrer Testsysteme bereit.

Die API stellt Ihnen drei verschiedene Endpunkte zur Verfügung:

Metadaten abfragen: https://gwatch.events/ext-api/metadata
Gast-Daten abrufen: https://gwatch.events/ext-api/pull
Gast-Daten hinzufügen oder ändern: https://gwatch.events/ext-api/push

Auf den folgenden Seiten finden Sie eine ausführliche Beschreibung der einzelnen Endpunkte und ihrer Nutzung.