Skip to main content

Ambientes

Produção

Homologação

As rotas ficam direto na raiz do domínio, sem prefixo de versão (ex.: https://api.dihub.com.br/diligences/emit).

Autenticação

Todas as rotas exigem o header X-Api-Token.
Sem o header, ou com token inexistente, vencido ou desativado, a API responde 401.

Como gerar seu token

Como criar, copiar e desativar tokens no dashboard.

Formato das respostas

As respostas JSON de sucesso vêm num envelope. O conteúdo do endpoint fica em data:
Erros usam o mesmo formato, com message explicando o problema e data trazendo detalhes quando houver:
Exceções:
  • 401 de autenticação: { "error": "Unauthorized", "message": ... }, com Missing or invalid api token (header ausente) ou Invalid token (token inexistente, vencido ou desativado).
  • GET /diligences/{id}/download-pdf e GET /diligences/{id}/download-zip: devolvem { "downloadUrl", "expiresAt" } direto, sem envelope.
  • GET /certificate/{id}/download-pdf: devolve o arquivo PDF.

Fluxo básico

  1. Gere seu token de API.
  2. Consulte GET /credits/balance para conferir o saldo.
  3. Consulte GET /diligences/districts para obter as comarcas válidas.
  4. Envie POST /diligences/emit para criar a diligência.
  5. Acompanhe com GET /diligences/{id}/status e GET /diligences/{id}/certificates.
  6. Baixe os arquivos com os endpoints de download.
Cobrança por cenário: Consumo de créditos.

Atalhos

Saldo de créditos

Consulte o saldo da conta autenticada.

Emitir diligência

Emita certidões, Análise DiHub ou os dois.

Estados e comarcas

Valores aceitos em state e district.

Consumo de créditos

Regra de cobrança por cenário.

Certidões e emissores

UFs disponíveis, certidões e emissores.