Pular para o conteúdo

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çoURLFinalidade
Aplicação Web DICEhttps://dice4.dustid.ioInterface Web própria para fluxos de trabalho DUST.
API DUSThttps://apid.dustid.ioAPI principal. Referência Scalar em /api/docs.
AuthDhttps://authd.dustid.ioContas, Organizações, sessões, OIDC e Contas de Serviço.

A API DUST disponibiliza a plataforma nestes caminhos de raiz:

CaminhoUtilização
/api/auth/tokenTrocar uma chave de API do AuthD por um token de portador.
/api/auth/jwksObter o JWKS do AuthD através da API DUST.
/api/v1/*Operações principais da API DUST.
/api/openapi.jsonEspecificação OpenAPI gerada e disponibilizada pela API.
/api/docsReferê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.

A API DUST disponibiliza sondas de estado padrão na raiz do servidor (não sob /api):

CaminhoVerificaçãoComportamento em caso de falha
/livezAtividade — o processo está em execução.Devolve sempre 200 enquanto o servidor estiver em execução.
/readyzDisponibilidade — 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.
/healthzNome 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).