Referencia de la API

Cada endpoint, esquema y estructura de error que aparece a continuación se genera mediante la propia API de DUST y se publica en línea, por lo que siempre coincide con la API desplegada.

Referencia integrada

Cargando la referencia de la API…La referencia está tardando más de lo habitual en cargarse. Puedes abrirla en una pestaña nueva mientras termina.

Abrir la referencia completa en una pestaña nueva

Por dónde empezar

• Inicio rápido — tu primera solicitud autenticada, de principio a fin.
• Autenticación — claves de API, intercambio de tokens y encabezados de contexto.
• Convenciones — la paginación y el contexto de solicitud compartido por todos los endpoints.
• Errores — la envoltura de error, los códigos que encontrarás en la práctica y cómo recuperarte.
• Guías de DICE — cómo se ven y se comportan los mismos registros en la aplicación web.

Consejo

El cliente de TypeScript se genera a partir de esta misma especificación, por lo que sus tipos siempre coinciden con lo documentado en la referencia.

Copias de la especificación

Hay disponibles dos copias de la especificación:

Fuente	URL	Actualización
API de DUST (en línea)	https://apid.dustid.io/api/openapi.json	Siempre coincide con la API desplegada.
Este sitio de documentación	/openapi.json	Se genera al compilar este sitio, a partir de la misma fuente que la API.

Al generar clientes o validar solicitudes, es preferible utilizar la copia en línea, ya que siempre coincide con la API desplegada. La copia del sitio se vuelve a generar con cada versión de la documentación y resulta práctica cuando ya estás navegando por este sitio.