Übersicht

Übersicht

Zugang zur API

UmFür die Nutzung der API nutzen zu können, benötigen Sieist mindestens einenein gültiger API-Schlüssel erforderlich (den sogenannten Hauptschlüssel). DiesenDieser erhalten Siekann über Ihrdas Teilnehmermanagement.zuständige JeTeilnehmermanagement nachbezogen werden. Abhängig vom Anwendungsfall kann es sein, dass Ihnenkönnen zusätzlich weitere Schlüssel bereitgestelltzur Verfügung gestellt werden. Die genaue Verwendung und Funktion der einzelnen Schlüssel wird im weiteren Verlauf derdieser Dokumentation erläutert.

DarüberDie hinausAPI empfehlenverwendet wir,JSON den(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.

Zusätzlich kann der Zugriff auf die API über eineneine IP-FilterFilterung einzuschränken.eingeschränkt Haltenwerden. SieEs daherwird idealerweiseempfohlen, die IP-AdresseAdresse(n) desder anfragenden ServersServer sowie(inkl. ggf.Testumgebungen) Ihrerim TestsystemeVorfeld bereit.zu definieren und bereitzuhalten.

API-Endpunkte

Die API stellt Ihnenbietet drei verschiedenededizierte Endpunkte zur Verfügung:Interaktion:

• Metadaten abfragen: https://gwatch.events/ext-api/metadata

  
  Zweck: Abfrage verfügbarer Metadaten und Konfigurationsinformationen.

• Gast-Daten abrufen: https://gwatch.events/ext-api/pull

  
  Zweck: Abruf vorhandener Gast-Daten.

• Gast-Daten hinzufügen oder ändern: https://gwatch.events/ext-api/push

  
  Zweck: Übertragung (Hinzufügen oder Aktualisieren) von Gast-Daten.

Weitere Informationen

AufDie genaue Struktur der Anfragen, das erwartete JSON-Format sowie mögliche Fehlermeldungen und Antwort-Codes werden auf den folgenden Seiten findenausführlich Sie eine ausführliche Beschreibung der einzelnen Endpunkte und ihrer Nutzung.beschrieben.