Skip to main content

(03) backend API

Über unsere Backend-API können Drittsysteme die Administration der Bots übernehmen. Hierzu wird zum Testen der API ein Swagger angeboten. Um diese API nutzen zu können, wird ein Token benötigt. Dieser kann im jeweiligen Bot unter Zugriff erstellt werden.

/api/external/checkauth

Request-Typ: GET Prüfroute für den generierten Token

/api/external/useraccess/user/byId/%userId%

Request-Typ: GET Abrufen einer Personalisierung unter Angabe der User-ID bei %userId%.

/api/external/useraccess/getusersinorg

Request-Typ: GET Rückgabe der aktuellen Personalisierungen in der Organisation des Bots.

/api/external/useraccess/user/byGuestId/%guestId%

Request-Typ: GET Abrufen einer Personalisierung unter Angabe der User-ID bei %guestId%.

/api/external/useraccess/users

Request-Typ: GET Abrufen der aktuellen Personalisierungsliste des Bots.

/api/external/useraccess/user

Request-Typ: POST Hinzufügen einer Personalisierung. Daten werden über den Request-Body kommuniziert.

{
"guestId": "string",
"usermeta": "string"
}

/api/external/useraccess/user

Request-Typ: PUT Aktualisieren einer Personalisierung. Daten werden über den Request-Body kommuniziert.

{
"guestId": "string",
"usermeta": "string"
}

/api/external/useraccess/user

Request-Typ: DELETE Löschen einer Personalisierung. Daten werden über den Request-Body kommuniziert.

{
"guestId": "string"
}

/api/external/useraccess/resetstats

Request-Typ: POST Zurücksetzen der Statistiken einer Personalisierung. Daten werden über den Request-Body kommuniziert.

{
"guestId": "string"
}