Référence de l’API

Chaque point de terminaison, schéma et structure d’erreur ci-dessous est généré par l’API DUST elle-même et diffusé en direct, de sorte que le contenu correspond toujours à l’API déployée.

Référence intégrée

Chargement de la référence API…Le chargement de la référence prend plus de temps que d’habitude. Vous pouvez l’ouvrir dans un nouvel onglet en attendant la fin du chargement.

Ouvrir la référence complète dans un nouvel onglet

Par où commencer

• Démarrage rapide — votre première requête authentifiée, de bout en bout.
• Authentification — clés d’API, échange de jetons et en-têtes de contexte.
• Conventions — la pagination et le contexte de requête commun à chaque point de terminaison.
• Erreurs — l’enveloppe d’erreur, les codes que vous rencontrerez réellement et la manière de rétablir la situation.
• Guides DICE — l’apparence et le comportement de ces mêmes fiches dans l’application web.

Astuce

Le client TypeScript est généré à partir de cette même spécification, de sorte que ses types correspondent toujours à ceux décrits dans la référence.

Copies de la spécification

Deux copies de la spécification sont disponibles :

Source	URL	Actualité
API DUST (en direct)	https://apid.dustid.io/api/openapi.json	Correspond toujours à l’API déployée.
Ce site de documentation	/openapi.json	Générée lors de la compilation de ce site, à partir de la même source que l’API.

Privilégiez la copie en direct lors de la génération de clients ou de la validation de requêtes : elle correspond toujours à l’API déployée. La copie du site est régénérée à chaque publication de la documentation et s’avère pratique lorsque vous consultez déjà ce site.