REST API Übersicht
Grundlegende Anforderungen
- Die API ist konform mit den HTTP- und REST-Spezifikationen aufgebaut. Abfrageanfragen werden beispielsweise mit der GET-Methode und Übermittlungsanfragen mit der POST-Methode durchgeführt. Wird eine Anfrage nicht mit der entsprechenden HTTP-Methode gestellt, gibt die REST API einen Fehler zurück.
- Sofern nicht anders angegeben, sind Parameterwerte standardmäßig wie folgt zu kodieren: UTF-8, URL-Encoding.
Rechenzentrum und Basis-URL
| Rechenzentrum | Basis-URL |
|---|---|
| Singapur | https://livedesk-api.engagelab.com |
Bei der Nutzung der REST API kombinieren Sie die gewählte Basis-URL mit dem spezifischen API-Pfad, um die vollständige Aufrufadresse zu erhalten.
{Basis-URL}/{API-Pfad}
{Basis-URL}/{API-Pfad}
Diesen Codeblock im schwebenden Fenster anzeigen
Authentifizierung
Die EngageLab REST API verwendet HTTP Basic Authentication: Fügen Sie der HTTP-Header-Zeile „Authorization“ Folgendes hinzu:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Diesen Codeblock im schwebenden Fenster anzeigen
Der base64_auth_string wird folgendermaßen generiert: base64(api_key:api_secret)
- Der Header-Name lautet „Authorization“, und der Wert ist das base64-kodierte „Benutzername:Passwort“-Paar (durch einen Doppelpunkt getrennt).
- Im Kontext der LiveDesk API ist der Benutzername der API Key und das Passwort der API Secret. Bitte fügen Sie unter „Projekteinstellungen – API-Management“ eine Datenquelle vom Typ API hinzu, um Ihren API Key und API Secret zu erhalten.
