Documentation: v2 REST API Dokumentation

API & Hooks -> Endpunkte -> Documentation

Direkter Link zur Dokumentation: REST API Dokumentation

Über den Menüpunkt öffnet sich die API Dokumentation (Swagger) in einem neuen Browser-Tab.

Download API Postman Collection, Postman Environment

Unter dem Menüpunkt API & Hooks -> Endpunkte -> Dokumentation kann über den Link "Download Postman Collection & Environment" direkt die Postman Collection und das Postman Environment als zip-Datei heruntergeladen werden. In Postman kann der entpackte Ordner importiert werden, wodurch die API Dokumentation und die Daten für die Authentifizierung über oAuth2 direkt in Postman verfügbar sind.

Alternativ kann die Postman Collection auch als json-Datei hier heruntergeladen werden:

80KB

onRetail V2 API.postman_collection.json

Open

Beschreibung der API Dokumentation (Swagger)

In der Dokumentation befindet sich eine Beschreibung der API, für verschiedene Datenmodelle sind Beispiele bzw. Schema im JSON-Format angegeben. Die verschiedenen Endpunkte können nach vorheriger Autorisierung über oauth2 direkt getestet werden.

Testen (Try it out)

Die API-Requests können nach vorheriger Autorisierung getestet werden.

Dafür wird einer der Requests in der Doku durch Anklicken ausgeklappt, und rechts oben der Button ausgewählt. Nun können die gewünschten Parameter gesetzt und durch Auswählen des Buttons der Request getestet werden.

Autorisierung

Die Autorisierung wird recht oben über den Button geöffnet. Im Bereich OAuth2 wird die client_id und das client_secret der zu testenden Verbindung eingegeben.

Über den Button bestätigen.

Nach erfolgreicher Autorisierung sollten die Daten im Fenster so aussehen.

Schemas

Am Ende der API Dokumentation befinden sich die Schemas der verschiedenen Modelle mit der Beschreibung der Felder und Datentypen.

Beispiel: Schema einer Angebotszeile in einem Angebot.