Health Check

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Introdução

O endpoint de Health Check permite verificar se a API do Gateway de Pagamento está operacional e respondendo corretamente. Este endpoint é útil para monitoramento de sistemas, verificações de conectividade e validação do status da API.

Verificar Status da API

HEAD /v1/health-check

Verifica se a API está funcionando corretamente e retorna o status de saúde do sistema.

Dicionário de dados - Parâmetros

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

🟢 200

API funcionando corretamente

HTTP/1.1 200 OK

Dicionário de dados - Retorno

STATUS CODE	DESCRIÇÃO
200	API está operacional e funcionando corretamente

🔴 500

Erro interno da API

HTTP/1.1 500 Internal Server Error

Dicionário de dados - Retorno

STATUS CODE	DESCRIÇÃO
500	API está com problemas internos ou indisponível

Casos de Uso

Monitoramento de Sistemas

Use este endpoint para implementar verificações automáticas de saúde da API em seus sistemas de monitoramento.

Verificação de Conectividade

Teste a conectividade com a API antes de realizar operações críticas.

Recomendações

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)

Importante

Este endpoint:

• Não requer autenticação
• Não retorna dados sensíveis
• Deve responder rapidamente (< 5 segundos)
• Pode ser usado para verificações frequentes sem impacto de rate limiting