Custom Endpoints

API & Hooks -> Endpunkte -> Custom Endpoints

Documentation

API & Hooks -> Endpunkte -> Documentation

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

API & Hooks -> Endpunkte -> Generate Client

Logging

Im Logging werden alle API-Requests protokolliert. In der Übersicht sieht man zu jedem Request Datum, Methode (POST/GET/..), die Aufruf-URL, sowie den Statuscode.

Beispiele für Statuscodes

Wählt man einen der Logging-Einträge aus der Übersicht durch Klicken aus, kann man zusätzlich den gesendeten Request und den erhaltenen Response einsehen.

Traffic

Hier werden die geloggten Requests nach Anzahl der Aufrufe, Statuscodes etc. ausgewertet.

Es stehen diverse Ansichten (Diagramm, Pivot, Liste) zur Verfügung, die rechts über die Icons geändert werden können.

Hier sieht man die Auswertung der Requests in der Pivot-Ansicht:

Hooks

Logging

Traffic

Actions

Die Anfrage wird manuell über das Kontext-/Aktionsmenü des jeweiligen Modells ausgelöst.

Automation

Wird automatisch ausgelöst, wenn der definierte Vorgang am Modell stattfindet, z.B. bei der Erstellung.

Schedules

Periodische Auslösung über einen Cron Job.