JSON-RPC 2.0 API

Das Webservice-Modul in XELOS unterstützt die Kommunikation über JSON-RPC 2.0.

Über JSON-RPC 2.0

JSON-RPC ist ein zustandsloses, leichtes Remote Procedure Call (RPC)-Protokoll. In erster Linie definiert diese Spezifikation mehrere Datenstrukturen und die Regeln um deren Verarbeitung. Es ist transportunabhängig, da die Konzepte innerhalb desselben Prozesses, über Sockets, über http oder in vielen verschiedenen Umgebungen für den Nachrichtenversand verwendet werden können. Als Datenformat wird JSON (RFC 4627) verwendet.

Mehr Informationen über JSON-RPC 2.0

Autorisierung und Zugriff

Der API-Zugriff ist auf autorisierte Konten beschränkt. Die Rollen und Rechte des verwendeten Kontos spiegeln sich auch in den verfügbaren Endpunkten und deren Funktionalität wider - z.B. verfügt ein administratives Konto über mehr API-Funktionen als ein normales Benutzerkonto. Es wird empfohlen, spezifische API-Konten zu erstellen und die Rechte auf den Zweck zu beschränken, für den sie erstellt wurden.

Grundlegende Authentifizierung

Die primäre Zugriffsmethode ist die Verwendung eines dedizierten API-Benutzers und die Verwendung von Login/Passwort als Basisauthentifizierung.

OAuth2 Autorisierungscode

Alternativ können Sie den OAuth2 Authorization Code Flow verwenden, um im Namen eines Benutzers auf die API zuzugreifen. Bitte konfigurieren Sie die zulässigen Apps in der Konfiguration des Webservice-Moduls.

Der angeforderte Umfang sollte die Module widerspiegeln, auf die Sie zugreifen möchten, getrennt durch Leerzeichen (z.B. "crm lookbook").

Bitte geben Sie beim Zugriff auf die API den access_token als Bearer Token im HTTP Autorisierungskopf an.
Beispiel:

Authorization: Bearer <TOKEN>