Rest API Referenz

Diese Dokumentation bietet eine strukturierte und leicht verständliche Übersicht über die REST API-Endpunkte. Sie unterstützt Entwicklerinnen und Entwickler dabei, die Schnittstellen effizient zu nutzen und deren Funktionalität gezielt einzusetzen. Diese Referenz dient als zentrale Informationsquelle für alle öffentlich zugänglichen API-Ressourcen. Sie erleichtert das Verständnis der Endpunkte, fördert eine schnelle Integration und unterstützt die Wiederverwendung bestehender Funktionen.

Die API-Dokumentation enthält detaillierte Informationen zu folgenden Bereichen:

• Endpunkte und Ressourcen: Beschreibung der verfügbaren HTTP-Endpunkte (GET, POST, PUT, DELETE), ihrer Pfade, Parameter und erwarteten Antworten.

• Fehlermeldungen und Statuscodes: Übersicht typischer HTTP-Statuscodes und deren Bedeutung im Kontext der API.

• Beispielanfragen und -antworten: Praktische Beispiele für API-Calls inklusive JSON-Payloads und Response-Formate.