Fiscal Contora
Fiscal Contora Infraestrutura fiscal
Documentação / Health Check v1
Quickstart OpenAPI IA Health
API REST fiscal

Monitore a saúde da plataforma e dos serviços em tempo real.

Esta documentação descreve a versão pública atual da API fiscal da Contora, com base compartilhada de empresas, certificados, chaves, filas, webhooks e artefatos para NF-e, NFC-e, NFS-e, CT-e e MDF-e. NF-e, NFC-e e NFS-e operam em produção regular; CT-e e MDF-e em produção assistida e controlada.

Atualizado em .

Health Check

A plataforma expõe endpoints de saúde pública para monitoramento da disponibilidade dos serviços. Use esses endpoints para verificar conectividade e prontidão sem expor a topologia interna da plataforma.

GET https://fiscal.contora.com.br/api/health (Básico - público)
GET https://fiscal.contora.com.br/api/health/ready (Readiness probe)
GET https://fiscal.contora.com.br/api/health/live (Liveness probe)

Health check básico

Endpoint público que retorna o status geral da plataforma. Não requer autenticação. Ideal para verificar se a API está respondendo. 

GET https://fiscal.contora.com.br/api/health
{
  "ok": true,
  "service": "Fiscal Contora",
  "version": "v1",
  "environment": "production",
  "timestamp": "2026-07-11T10:30:00-03:00",
  "documents": ["nfe", "nfce", "cte", "nfse", "mdfe"]
}

Diagnóstico detalhado

O diagnóstico de banco, filas, storage, circuit breakers, workers e scheduler é restrito à equipe de operação autenticada com MFA. Ele não faz parte do contrato público nem deve ser usado por integrações.

Status possíveis

ok
Componente funcionando normalmente
warning
Componente com degradação leve
error
Componente com falha
critical
Componente com falha crítica
unknown
Status não determinado

Circuit Breaker SEFAZ

A plataforma implementa circuit breaker para proteger contra falhas em cascata na SEFAZ. Quando o circuito está aberto, novas requisições são rejeitadas automaticamente.

closed
Normal - requisições são enviadas à SEFAZ
open
Bloqueado - requisições são rejeitadas (aguarda recovery_timeout)
half_open
Testando - requisições limitadas para verificar recuperação
Threshold 5 falhas consecutivas abrem o circuito.
Recovery timeout 5 minutos antes de tentar novamente.

Readiness e Liveness probes

Para ambientes com orquestração (Kubernetes, Docker Swarm), use os endpoints de readiness e liveness.

Readiness (/health/ready) Retorna 200 quando a plataforma está pronta para receber tráfego. Retorna 503 quando algum componente crítico está com falha.
Liveness (/health/live) Retorna 200 sempre que a aplicação está respondendo. Use para verificar se o processo está vivo.

Uso recomendado

  • Use /api/health para monitoramento externo simples.
  • Configure alertas quando readiness responder HTTP 503.
  • Use readiness probe no load balancer para drenar tráfego em caso de falha.
  • Consulte o status do documento e os webhooks para acompanhar cada emissão.