Gast- / Event-API

Mit der guestoo API hast Du Zugriff auf Event- und Gast-Daten.

Du kannst für das guestoo Back-End zwischen zwei Darstellungsoptionen wählen. Die Screenshots in der Doku basieren auf dem "Klassischen Design".
Hier siehst Du die Unterschiede, damit Du dich auch im "Modernen Design" zurecht findest: » guestoo Back-End-Design

Was kann ich hiermit machen?

  • Auf die Event-Daten per OAuth oder mit Token-Authentifizierung lesend zugreifen

  • Auf die Gast-Daten per OAuth lesend und schreibend zugreifen

Bitte habe Verständnis dafür, dass wir die Dokumentation der API nur angemeldeten Nutzern zeigen. Du findest sie direkt in guestoo unter dem Menüpunkt "API".

Inhalte dieser Seite:

Event-API

 

Im Tab "Event-API" findest Du alle wichtigen Informationen, die Du zur Verwendung der API zur Synchronisierung von Event-Daten benötigst.

Gäste-API

 

Im Tab "Gäste-API" findest Du alle wichtigen Informationen, die Du zur Verwendung der API zur Synchronisierung von Gast-Daten benötigst.

API-Benutzer

 

Im Tab "API-Benutzer" findest Du oben eine Übersicht der Informationen, die Du als Zugangsdaten für die Schnittstelle benötigst. Die Authentifizierung ist entweder über OAuth oder über einen Token möglich. 

Falls Du nicht weißt, wo diese Daten eingegeben werden müssen, wende Dich am Besten an eine:n Entwickler:in/IT-Beauftragte:n.

 

Bevor die Verbindung zur API aufgebaut werden kann, musst Du allerdings einen entsprechenden API-User anlegen.

So gehts:

  • Gehe in den Menüpunkt "API"
  • Wechsle in den Tab "API-Benutzer"
  • Klicke auf den Button "+Neuer API-User"
  • Es erscheint unten ein neuer User, bei dem Du die folgenden Informationen pflegen musst:
  • Type
    Hier wählst Du zwischen "OAuth" und "Token" aus, indem Du auf den entsprechenden Button klickst.
  • Zugriff
    Wähle hier aus, auf welche Daten der API-User zugreifen darf (Mehrfachauswahl möglich):
    • Event-API
    • Agentur-API
    • Gäste-API
  • Schlagwort
    Wenn Du an dieser Stelle ein Schlagwort auswählst, hat der API-User nur Zugriff auf die Events, denen dieses Schlagwort zugewiesen ist.
  • Bei der Verwendung von OAuth:
    • Client ID
      Die Client ID wird von guestoo automatisch generiert und muss bei der Authentifizierung angegeben werden.
    • Client Secret
      Das Client Secret wird von guestoo automatisch generiert und muss bei der Authentifizierung angegeben werden.
  • Bei der Verwendung von einem Token:
    • CPApiToken
      Der API-Token wird von guestoo automatisch generiert und muss bei der Authentifizierung angegeben werden.
  • Fertig!
API-User erneuern

Wenn Du unter einem User auf den Button "Erneuern" klickst, wird das Client-Secret bzw. der Token neu generiert. Es sind dann keine Abrufe der API mit den alten Zugangsdaten mehr möglich!

API-User deaktivieren

Mit einem Klick auf den Button "Deaktivieren" kannst Du den API-Zugang eines Users deaktivieren. Es sind dann keine Abrufe der API mehr möglich! Du kannst den API-User zu einem späteren Zeitpunkt wieder aktivieren, indem Du auf den "Aktivieren"-Button unter dem User klickst.

API-User löschen

Mit einem Klick auf den Button "Löschen" kannst Du den API-Zugang eines Users unwiederbringlich löschen. Es sind dann keine Abrufe der API mehr möglich!

Vorherige Seite Nächste Seite