Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve o estado de todos os serviços da Didit, o estado geral e os incidentes em curso ou resolvidos nos últimos 7 dias. O endpoint é público: não envie nenhum cabeçalho de autenticação. A resposta não contém dados da organização e é a mesma para todos os chamadores.

Quando usar

  • Widget de estado: mostre aos seus utilizadores ou à sua equipa de suporte se um serviço da Didit está degradado neste momento.
  • Verificação de estado da integração: antes de atribuir a culpa ao seu próprio código por verificações lentas ou com falhas, veja se a Didit reporta um incidente no serviço que está a chamar.
  • Histórico de incidentes: liste o que aconteceu nos últimos 7 dias e quanto tempo durou cada incidente.
Para verificar apenas se a API está acessível, use o healthcheck.

Consultas periódicas

As respostas ficam em cache durante 30 segundos, por isso faça consultas no máximo uma vez a cada 30 segundos. updated_at indica quando a Didit gerou a resposta que recebeu. Aplica-se também um limite de pedidos GET de 600 por minuto por endereço IP.

Serviços

services lista todos os serviços, tenham ou não um incidente. Faça a correspondência pelo key: name é um nome de apresentação em inglês e pode mudar. O status de cada serviço é operational, degraded ou down. É operational quando o serviço não tem nenhum incidente em curso; caso contrário, é o pior estado dos seus incidentes em curso. O status de nível superior é o pior estado de todos os serviços.

Incidentes

incidents lista todos os incidentes em curso e os incidentes resolvidos nos últimos 7 dias, do started_at mais recente para o mais antigo. São listados no máximo 50 incidentes resolvidos.
  • state é degraded ou down. Um incidente resolvido mantém o último estado que teve.
  • status é ongoing até o serviço recuperar, e depois passa a resolved.
  • resolved_at e duration_minutes são null enquanto o incidente estiver em curso.
  • affected e country_name indicam o país ou registo afetado, por exemplo Brazil (CPF) e Brazil. Ficam vazios quando o incidente não está associado a um país ou registo.
  • title e body estão em inglês. Para mostrar o incidente noutro idioma, crie o seu próprio texto a partir de service, state e country_name.

Exemplo de resposta

Ver também

  • Healthcheck: uma sonda de disponibilidade pública que também não requer nenhum cabeçalho de autenticação.
  • Webhooks de alerta: receba alert.service.degraded e alert.service.recovered no seu endpoint, para os serviços usados pela sua organização.
  • Limites de pedidos

Resposta

Estado atual do serviço.

Estado público do serviço: o estado de cada serviço Didit, o estado global e os incidentes que estão em curso ou foram resolvidos nos últimos 7 dias.

status
enum<string>
obrigatório

O pior estado de qualquer serviço neste momento, determinado apenas pelos incidentes em curso.

Opções disponíveis:
operational,
degraded,
down
Exemplo:

"degraded"

updated_at
string<date-time>
obrigatório

Quando a Didit construiu esta resposta (ISO 8601, UTC). As respostas são guardadas em cache durante 30 segundos, pelo que podem ter até 30 segundos de antiguidade.

Exemplo:

"2026-10-13T09:41:07.512345Z"

services
object[]
obrigatório

Uma entrada por serviço, com todos os serviços sempre listados.

incidents
object[]
obrigatório

started_at mais recente primeiro. Todos os incidentes em curso, mais os incidentes resolvidos nos últimos 7 dias (no máximo 50 incidentes resolvidos). Vazio quando nada aconteceu nesse período.

Última modificação em 7 de novembro de 2026