Guest & Event API

With the guestoo API you have accesss to event and guest data.

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?

  • Access event data via OAuth or token authentication in read-only mode

  • Read and write access to guest data via OAuth

Please understand that we only show the API documentation to registered users. You can find it directly in guestoo under the menu item “API”.

Inhalte dieser Seite:

Event API

 

In the "Event API" tab, you'll find all the relevant information that you need to use the API in order to synchronise event data.

Guest API

 

In the "Guest API" tab, you'll find all the relevant information that you need to use the API in order to synchronise guest data.

API user

 

In the "API User" tab, you'll find an overview of the information that you need as the access data for the API interface. Authentication is possible either via OAuth or via a Token. 

If you are unsure where to enter this information, it is best to consult a developer or IT representative.

 

Before you're able to establish a connection to the API, you'll have to create an API user for this purpose.

This is how:

  • Go to the menu item "API"
  • Switch to the "API User" tab
  • Click on the button "+Add API user"
  • A new user will appear below, for which you must maintain the following information:
  • Type
    Here you can choose between “OAuth” and “Token” by clicking on the corresponding button.
  • Access
    Here you choose which data the API user is supposed to have access to (Multiple selection possible):
    • Event API
    • Agency API
    • Guest API
  • Keyword
    If you choose a keyword here, the API user will only have access to the events which have that keyword assigned to them.
  • When using OAuth:
    • Client ID
      The client ID is automatically created by guestoo and has to be entered during authentication.
    • Client Secret
      The client secret is automatically created by guestoo and has to be entered during authentication.
  • When using a Token:
    • CPApiToken
      The API token is automatically created by guestoo and has to be entered during authentication.
  • Done!
Renew API user

If you click on the “Refresh” button under a user, the client secret or token will be generated again. It will then no longer be possible to access the API with the old access data!

Disable API user

By clicking on the “Deactivate” button, you can deactivate a user's API access. API calls will then no longer be possible! You can reactivate the API user at a later date by clicking on the “Activate” button below the user.

Delete API user

By clicking on the “Delete” button, you can permanently delete a user's API access. It will then no longer be possible to access the API!

Vorherige Seite Nächste Seite