Pular para o conteúdo

GET /api/ping

Endpoint de saúde barato. Devolve 200 com um corpo JSON mínimo quando a Function App está no ar. Não exige cabeçalho de autenticação — use-o em monitores de disponibilidade e em smoke tests de CI.

Requisição

Resposta

{
  "status": "ok",
  "service": "qr-branding",
  "version": "1.6.2",
  "now": "2026-05-24T08:14:31Z"
}
  • status — sempre "ok" quando a função é executada. Se não fosse, você receberia um erro de conexão, não um corpo JSON.
  • version — semver do motor implantado.
  • now — relógio do servidor em UTC. Útil para verificar se a sua assinatura X-Internal-Ts não está com desvio.

Casos de uso

  • Monitor de disponibilidade: chame /api/ping a cada 60s; alerte em qualquer resposta diferente de 200.
  • Smoke test de CI: depois de cada deploy, faça o pipeline falhar se version não corresponder à tag que você acabou de enviar.
  • Verificação de desvio de relógio: compare now com o relógio do seu cliente ao depurar 401 INVALID_SIGNATURE do BFF interno (o TTL é de 60s; um desvio > 90s faz o HMAC falhar).

O que ele NÃO verifica

O ping é barato de propósito. Ele não valida:

  • Se o banco de dados está acessível.
  • Se os provedores de LLM respondem.
  • Se os seus cabeçalhos de autenticação da RapidAPI / internos estão configurados corretamente.

Para verificações mais profundas, chame /api/qr/generate com um payload mínimo (só content) e verifique se o QR volta.