Teste de conectividade (Healthcheck)
Valida a conectividade com a API e a autenticação. Retorna status do serviço e ambiente.
Overview
Use para verificar se sua API Key está válida e se a API está respondendo. Útil em scripts de monitoramento ou no início da integração.
Endpoint
GETGET /status/health
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/status/health" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"status": "ok",
"environment": "production",
"timestamp": "2025-02-09T12:00:00.000Z"
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| status | string | Indica se o serviço está operacional (ex.: ok). |
| environment | string | Ambiente da API (production ou sandbox). |
| timestamp | string | Data/hora da resposta (ISO 8601). |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 401 | INVALID_API_KEY | Chave inválida ou expirada. Verifique o header X-API-Key. |
Exemplo de resposta de erro
JSON
{
"code": "INVALID_API_KEY",
"message": "Chave de API inválida ou expirada."
}