Referência da API

Todos os endpoints, esquemas e formatos de erro abaixo são gerados pela própria API DUST e disponibilizados em direto, pelo que correspondem sempre à API implementada.

Referência incorporada

A carregar a referência da API…A referência está a demorar mais do que o habitual a carregar. Pode abri-la num novo separador enquanto termina.

Abrir a referência completa num novo separador

Por onde começar

• Início rápido — o primeiro pedido autenticado, do princípio ao fim.
• Autenticação — chaves de API, troca de tokens e cabeçalhos de contexto.
• Convenções — paginação e o contexto do pedido partilhado por todos os endpoints.
• Erros — o envelope de erro, os códigos que irá efetivamente encontrar e como recuperar.
• Guias do DICE — como os mesmos registos são apresentados e funcionam na aplicação Web.

Dica

O cliente TypeScript é gerado a partir desta mesma especificação, pelo que os respetivos tipos correspondem sempre ao que está documentado na referência.

Cópias da especificação

Estão disponíveis duas cópias da especificação:

Origem	URL	Atualidade
API DUST (em direto)	https://apid.dustid.io/api/openapi.json	Corresponde sempre à API implementada.
Este site de documentação	/openapi.json	Gerada quando este site é compilado, a partir da mesma origem que a API.

Prefira a cópia em direto ao gerar clientes ou validar pedidos — corresponde sempre à API implementada. A cópia do site é gerada novamente a cada nova versão da documentação e é prática quando já está a navegar neste site.