Endpunkte

Custom Endpoints

Documentation

API Dokumentation

In diesem Bereich befindet sich die API Dokumentation, die sich in einem neuen Browser-Tab öffnet.

Hier ist die API beschrieben und man kann für verschiedene Datenmodelle Beispiele bzw. das Schema im JSON-Format einsehen.

Testen (Try it out)

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

Dafür klappt man einen der Requests in der Doku durch Anklicken aus, und klickt rechts oben auf den Button . Nun kann man die gewünschten Parameter setzen und durch Klick auf den Button den Request testen.

Autorisierung

Rechts oben auf den Button klicken und ganz nach unten zu OAuth2 scrollen.

Hier ist client_id sowie client_secret der zu testenden Verbindung einzugeben.

Anschließend auf den Button klicken.

Nach erfolgreicher Autorisierung sollten die Daten im Fenster so aussehen.

Schemas

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

Beispiel: Schema einer Angebotszeile in einem Angebot.

Generate Client