API-Referenz

Jeder unten aufgeführte Endpunkt, jedes Schema und jede Fehlerstruktur wird von der DUST API selbst generiert und live bereitgestellt, sodass alles stets mit der bereitgestellten API übereinstimmt.

Eingebettete Referenz

API-Referenz wird geladen…Das Laden der Referenz dauert länger als üblich. Sie können sie währenddessen in einem neuen Tab öffnen.

Die vollständige Referenz in einem neuen Tab öffnen

Erste Schritte

• Schnellstart — Ihre erste authentifizierte Anfrage von Anfang bis Ende.
• Authentifizierung — API-Schlüssel, Token-Austausch und Kontext-Header.
• Konventionen — Paginierung und der von allen Endpunkten gemeinsam verwendete Anfragekontext.
• Fehler — die Fehlerhülle, die Codes, auf die Sie tatsächlich stoßen werden, und wie Sie Fehler beheben.
• DICE-Anleitungen — wie dieselben Datensätze in der Web-App aussehen und sich verhalten.

Tipp

Der TypeScript-Client wird aus derselben Spezifikation generiert, sodass seine Typen stets mit der Referenzdokumentation übereinstimmen.

Kopien der Spezifikation

Die Spezifikation ist in zwei Ausführungen verfügbar:

Quelle	URL	Aktualität
DUST API (live)	https://apid.dustid.io/api/openapi.json	Entspricht stets der bereitgestellten API.
Diese Dokumentationswebsite	/openapi.json	Wird beim Erstellen dieser Website aus derselben Quelle wie die API generiert.

Verwenden Sie zum Generieren von Clients oder Validieren von Anfragen bevorzugt die Live-Version — sie entspricht stets der bereitgestellten API. Die Version auf der Website wird mit jeder Veröffentlichung der Dokumentation neu generiert und ist praktisch, wenn Sie bereits hier navigieren.