Ambientes
O DUST é executado como três serviços implementados. A maioria das integrações necessita apenas da API DUST; o AuthD é acedido através dos caminhos /api/auth/* da API.
| Serviço | URL | Finalidade |
|---|---|---|
| Aplicação Web DICE | https://dice4.dustid.io | Interface Web própria para fluxos de trabalho DUST. |
| API DUST | https://apid.dustid.io | API principal. Referência Scalar em /api/docs. |
| AuthD | https://authd.dustid.io | Contas, Organizações, sessões, OIDC e Contas de Serviço. |
Caminhos da API
Seção intitulada “Caminhos da API”A API DUST disponibiliza a plataforma nestes caminhos de raiz:
| Caminho | Utilização |
|---|---|
/api/auth/token | Trocar uma chave de API do AuthD por um token de portador. |
/api/auth/jwks | Obter o JWKS do AuthD através da API DUST. |
/api/v1/* | Operações principais da API DUST. |
/api/openapi.json | Especificação OpenAPI gerada e disponibilizada pela API. |
/api/docs | Referência Scalar interativa. |
Consulte a Referência da API para ver o catálogo completo de endpoints gerado e as Convenções para conhecer os cabeçalhos de contexto do pedido incluídos em cada chamada.
Endpoints de estado
Seção intitulada “Endpoints de estado”A API DUST disponibiliza sondas de estado padrão na raiz do servidor (não sob /api):
| Caminho | Verificação | Comportamento em caso de falha |
|---|---|---|
/livez | Atividade — o processo está em execução. | Devolve sempre 200 enquanto o servidor estiver em execução. |
/readyz | Disponibilidade — inclui uma comunicação de ida e volta com a base de dados. | Devolve 503 se a verificação da base de dados falhar ou exceder o tempo limite de 2 segundos. |
/healthz | Nome alternativo para a verificação de disponibilidade. | Igual a /readyz. |
Quando estão operacionais, os três devolvem { "status": "ok", "timestamp": "…" }; quando não estão, as verificações de disponibilidade devolvem { "status": "error", … } com um 503. Direcione os monitores de disponibilidade para /readyz (ou /healthz).