Einleitung

Diese Dokumentation ist nicht mehr aktuell. Die Schnittstelle hat sich geändert. Die Dokumentation der neuen Schnittstelle finden Sie unter Externes API.

GATEWatch stellt ein API bereit, welches es externen Diensten ermöglicht Daten aus dem System zu erhalten.

Das API wird über die Url https://gwatch.events/ext-api als POST Request aufgerufen und liefert JSON als Response zurück.

Zur Authentifikaion bekommen Sie auf Nachfrage vom Administrator einen Zugriffsschlüssel für die jeweilige Veranstaltung.

Die Schnittstelle kann darüberhinaus über einen IP Filter abgesichert werden. Wenn es möglich ist, dass Anfragen nur über eine bestimmte IP erfolgen, ist dies auf jeden Fall empfehlenswert. Auch mehrere IP's können eingetragen werden.

Zur Zeit umfasst die Schnittstelle nur die Möglichkeit Daten der Veranstaltung und der Gäste zu exportieren. Zu einem späteren Zeitpunkt könnte aber eine Erweiterung erfolgen, die mehr Möglichkeiten bietet. Die Daten, welche für die Veranstaltung bzw. die Gäste zurückgegeben werden, sind zum großen Teil frei definierbar. Bitte sprechen Sie mit Ihrem Administrator um sicherzustellen, dass Sie über die Schnittstelle die Daten beziehen können, welche Sie benötigen.