Client-Bibliotheken
Sie brauchen keine spezielle Bibliothek: Jede Programmiersprache kann die REST-API direkt aufrufen. Wenn Sie lieber einen fertigen Client nutzen, erzeugen Sie ihn in einer Minute aus unserer OpenAPI-Datei.
- 1 Laden Sie die OpenAPI-Datei herunter (oder kopieren Sie ihre Adresse).
- 2 Starten Sie den Generator für Ihre Sprache (Beispiele unten).
- 3 Nutzen Sie den erzeugten Client mit Ihrem API-Schlüssel.
Die OpenAPI-Datei
Die OpenAPI-Datei beschreibt alle Endpunkte, Felder, Berechtigungen und Fehler der API in einem Standardformat. Sie ist immer aktuell, weil sie aus denselben Daten wie diese Dokumentation entsteht.
Maschinenlesbare Beschreibung aller Endpunkte (OpenAPI 3.1) für Client-Generatoren, Postman und Swagger UI.
Adresse der OpenAPI-Datei
https://docs.plandocket.com/de/openapi.jsonMit OpenAPI Generator
OpenAPI Generator erzeugt Clients für mehr als 50 Sprachen. Ist Docker installiert, genügt ein Befehl:
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli generate \
-i https://docs.plandocket.com/de/openapi.json \
-g php \
-o /local/api-clientErsetzen Sie den Sprachnamen für andere Clients, zum Beispiel typescript-fetch, java, csharp oder go.
In API-Werkzeuge importieren
Postman, Insomnia, Bruno und Swagger UI können die OpenAPI-Datei direkt importieren. Sie erhalten dann alle Anfragen sendebereit, nach Ressource gruppiert.
In Postman: Import, dann die Adresse der OpenAPI-Datei einfügen, dann die Variable für Ihren API-Schlüssel setzen.
Anmeldung im erzeugten Client
Hinterlegen Sie Ihren API-Schlüssel als Bearer-Token (Header Authorization: Bearer IHR_API_SCHLUESSEL). Die erzeugten Clients bieten dafür eine Einstellung, meist accessToken oder bearerToken genannt.
Authentifizierung