Senden Sie bei jedem Aufruf den Header Authorization: Bearer <key>. Ungültiger Schlüssel: 401; gültiger ohne Scope des Endpunkts: 403.
Der Header
Jede Anfrage an die externe API trägt den Header Authorization mit dem Wert „Bearer“, gefolgt vom Schlüssel. Basis-URL und interaktive Referenz stehen auf der Seite der API-Dokumentation; die OpenAPI-3.1-Spezifikation liegt unter /openapi.json und lässt sich in Postman, Bruno oder den Client-Generator Ihrer Sprache importieren.
Antwortcodes
Ohne Header oder mit ungültigem oder widerrufenem Schlüssel lautet die Antwort 401. Bei einem gültigen Schlüssel ohne den vom Endpunkt verlangten Scope (zum Beispiel POST /employees ohne employees:write) lautet sie 403, und der Body nennt den fehlenden Scope. Validierungsfehler kommen als 422 mit der Liste der Felder und Meldungen, in der Sprache des Headers Accept-Language.
Sprache und Format
Senden Sie Accept-Language (pt-BR, en, es, de oder ru), um übersetzte Fehlermeldungen zu erhalten. Daten gehen im Format ISO 8601 ein und aus, Geldbeträge als Dezimalzahlen mit der Währung daneben, und Listenantworten sind paginiert.