Health Check

HEAD/v1/health-check

Verifica se a API está operacional e respondendo corretamente. Este endpoint é útil para monitoramento de sistemas e verificações de conectividade.

Este endpoint não requer autenticação e não retorna dados sensíveis.

Verificar Status da API

Este endpoint não requer parâmetros de entrada nem autenticação.

Exemplo de requisição

curl --request HEAD \
  --url 'https://api.enoqpay.com.br/gateway/v1/health-check' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Respostas

Status Code	Descrição
`200`	API está operacional e funcionando corretamente
`500`	API está com problemas internos ou indisponível

Boas práticas para uso do Health Check:

Configure verificações automáticas a cada 1–5 minutos
Implemente alertas baseados em falhas consecutivas
Use como teste inicial antes de operações críticas
Configure timeouts apropriados (recomendado: 10–30 segundos)

Este endpoint não retorna dados sensíveis e não está sujeito a rate limiting para verificações frequentes.

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

API está com problemas internos ou indisponível

HTTP/1.1 500 Internal Server Error

A resposta não possui corpo. Não há campos JSON para interpretar neste cenário.