Was ist die API von edoobox

Mit der edoobox API haben Kunden von edoobox einen direkten Zugriff auf alle Daten. Dies erleichtert die Anbindung an 3rd Party Applikationen und einer individuellen Ausgabe auf deren Website. Enthalten sind sämtliche Ressourcen von edoobox via JSON Web Token und natürlich verfügen allen Ressourcen die Optionen POST, PUT, GET und DELETE.

Berechtigungsgruppen

Mit der API V2 haben Sie die Möglichkeit, die APIs mit angepassten Rechten auszustatten. Brauchen Sie zum Beispiel alle Rechnungsinformationen für Ihr Buchhaltungstool, so erlauben Sie in einer extra für die API erstellten Rechtsgruppe nur die benötigten Informationen.

Die 4 Haupt-Berechtigungsgruppen «Superadministrator Rechte», «Administrator und Leiter Rechte», «Nur begrenzte Leiter Rechte» und der «Leiter (begrenzt)» sind gedacht, um den Zugriff der Administratoren Im System zu limitieren. Diese können auch für den API V2 Zugriff verwendet werden, da man als Admin automatisch Zugriff mit seinen Logindaten auf die API V2 erhält.

Bitte beachten: Weiterer Berechtigungsgruppen

edoobox schlägt aber vor, wenn man Einschränkungen auf die API V2 einführen will, dass man eine neue Berechtigungsgruppe erstellt, um zu verhindern, dass ein Admin, ein für den Administratoren relevantes Recht verliert. Dies könnte nämlich dazu führen, dass die APP nicht so funktioniert wie angedacht oder zu viele Rechte an die API vergeben werden..

Zugang zur API V2

Unter folgendem Link erhalten Sie Zugriff auf den Postman von der edoobox API V2: https://api.docs.edoobox.com/

Tipp: Postman (Entwickler)

Postman bietet die Möglichkeit, API-Anfragen zu erstellen, zu testen, zu simulieren und zu debuggen, wodurch die API-Entwicklung für alle einfacher wird.

Info: Base URL

Bitte verwenden Sie für das Login ihr Benutzername und Kennwort des edoobox-Admins sowie als Base URL “https://app1.edoobox.com/v2“.

Zugriff mit Postman

Falls Sie mit Postman arbeiten, erstellen Sie eine Environment mit allen notwendigen Variablen. Wählen Sie nach dem Erstellen der Environment im Postman diese Environment aus und führen Sie den /auth-Request aus. Mögliche Environment-Variablen für den Zugriff auf die POST Auth API Schnittstelle:

base_url

https://app1.edoobox.com/v2

api_key

key_330498self9450ss93464ls345

api_sec

sec_e1b3d4bdbf273450405ab342

edid

token

expire

yubikey


Zurzeit können keine Environments in die Dokumentation publiziert werden.

Zugriff ohne Postman

Mit curl würde ein typischer Request wie folgt aussehen. Die Abfrage in weitere Programmiersprache können erstellt werden.

curl --location -g --request POST 'https://app1.edoobox.com/v2/auth' --header 'grant-type: password' --head
er 'Content-Type: application/json' --data-raw '{
"key": "<Ihr key-Schlüssel>",
"secret":"<Ihr sec-Schlüssel>",
"expire":"2030-01-01T01:00:00+02:00"
}'
CODE

Der Code kann in einem unabhängigen Docker-Container ausgeführt werden und sollten den HTTP-Status 200 mit der erwünschten JSON-Response zurückgeben.

Info: ERROR Codes der API

Eine komplette Liste aller Error Codes finden Sie unter folgendem Link: edoobox API V2

Info: Ungültige API

Überprüfen Sie, dass die API-Keys gültig sind für die Sandbox oder Live Umgebung und aktiviert sind.

Info: Authentifizierung mit Benutzernamen und Passwort

Die API V2 erlaubt Authentifizierung mit Passwort und Benutzernamen nur mit HTTPOnly Cookie. Im Request muss die Eigenschaft reply als Wert cookie gesetzt werden. Danach müssen für alle weiteren Requests die Header cookie mit dem Cookie _edlogin=<cookie-token>edid: <edid> und dem grant-type: access_token enthalten.

Falls man statt einem HTTPOnly Cookie einen Token möchte, kann man sich mit den Authentifizierungsschlüssel authentifizieren.

Zugang zur API V1

Die «API V1 Zugangsverwaltung» finden Sie in der «Hauptnavigation» unter «Einstellungen».
Um Zugriff auf die API V1 zu erhalten, müssen Sie in Ihrem edoobox Konto API Keys erstellen. Gehen Sie dazu in die «Einstellungen», welche Sie in der «Hauptnavigation» finden. Unter «API Zugangsverwaltung» können Sie den Button „Schlüssel hinzufügen“ anwählen.

edoobox REST API V1 - Anleitung

Info: API V1

Die API V1 wird nicht mehr weiterentwickelt und sollte aus diesem Grund nicht mehr verwendet werden. Bestehende Schnittstellen werden weiterhin noch funktionieren.
Weiterhin wird die API V1 auch für das WordPress-Plugin verwendet. Hier muss kein neuer Key erstellt werden.