Saúde da plataforma: referência da API

Saúde da plataforma

Endpoint público e sem autenticação para o seu monitor: diz numa só consulta se a plataforma está no ar e se o provedor de SMS está respondendo agora.

1 operação

URL basehttps://api.messages.ccxcompany.co

AutenticaçãoSem autenticação

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

Saúde da plataforma e do provedor de canal

GET/health/deep

Endpoint público e sem autenticação, desenhado para o seu monitor sintético consultar a cada minuto. Leia o campo smsProvider, não apenas o código HTTP.

Faz as checagens internas da plataforma MAIS uma sonda de leitura no provedor de SMS (uma operação barata, nunca um envio). O resultado da sonda é cacheado por 30 segundos.

Leia o campo `smsProvider`, não apenas o código HTTP — é ele que separa os dois cenários:

Leitura	Diagnóstico
`status: "fail"` (HTTP 503)	Plataforma CCX indisponível
`status: "ok"` + `smsProvider: "fail"`	CCX no ar, provedor do canal fora
`status: "ok"` + `smsProvider: "ok"`	Ambos no ar

smsProvider NÃO entra no status agregado de propósito: um provedor fora do ar não deve tirar a plataforma inteira de operação, levando junto WhatsApp, e-mail e painel.

skipped num campo significa que aquela dependência não está configurada neste ambiente — não é falha.

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`status`obrigatório	`string`	Valores:`okfail`
`uptimeSec`obrigatório	`number`
`checks`obrigatório	`object`
`checks.database`obrigatório	`object`
`checks.database.status`obrigatório	`string`	Valores:`okfailskipped`
`checks.database.latencyMs`obrigatório	`integer`
`checks.cache`obrigatório	`object`
`checks.cache.status`obrigatório	`string`	Valores:`okfailskipped`
`checks.cache.latencyMs`obrigatório	`integer`
`checks.workers`obrigatório	`object`
`checks.workers.status`obrigatório	`string`	Valores:`okfailskipped`
`checks.workers.latencyMs`obrigatório	`integer`
`checks.apiRoutes`obrigatório	`object`
`checks.apiRoutes.status`obrigatório	`string`	Valores:`okfailskipped`
`checks.apiRoutes.latencyMs`obrigatório	`integer`
`checks.smsProvider`opcional	`object`
`checks.smsProvider.status`obrigatório	`string`	Valores:`okfailskipped`
`checks.smsProvider.latencyMs`obrigatório	`integer`

JSON

{  "status": "ok",  "uptimeSec": 0,  "checks": {    "database": {      "status": "ok",      "latencyMs": 0    },    "cache": {      "status": "ok",      "latencyMs": 0    },    "workers": {      "status": "ok",      "latencyMs": 0    },    "apiRoutes": {      "status": "ok",      "latencyMs": 0    },    "smsProvider": {      "status": "ok",      "latencyMs": 0    }  }}

503Default Response

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/health/deep'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Saúde da plataforma

Saúde da plataforma e do provedor de canal

Respostas

Exemplo em curl

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.