API Documentation

The plenigo API documentation describes the possible queries and available endpoints of the plenigo API v3. 

Queries
The HTTP methods (e. g. GET, POST) determine the type of operation at the ressource. 
Die HTTP-Methoden (z. B. GET, POST) bestimmen die Art der Operation an der Ressource. Mit Abfrageparametern können zusätzliche Optionen für die GET-Anfragen bereitgestellt werden. POST-Parameter liefern die Daten für Schreiboperationen wie Erstellung, Änderung der Ressource(n).

Responses
Die Antwort der API erfolgt im JSON-Format. Derzeit unterstützt die plenigo API kein anderes Antwortformat.

Error Handling
Um den Erfolg oder Misserfolg eines API-Aufrufs anzuzeigen, kommen HTTP Status Codes zum Einsatz. Der Body der Antwort enthält die Details des Fehlers im JSON-Format

Standardmäßig werden folgende Code-Gruppen verwendet:

  • Code 2xx - zeigen einen erfolgreichen Aufruf an.

  • Codes 4xx - zeigen ein clientseitiges Problem mit dem Aufruf an. 

  • Codes 5xx - zeigen ein serverseitiges Problem mit dem Aufruf an.