4UptimePage EntrarCriar conta grátis

Como monitorar uma API: além do 200 OK

Guia prático para monitorar APIs REST com checagens de status, conteúdo, autenticação, tempo de resposta e endpoints de saúde, sem criar alertas falsos.

Por Equipe UptimePage · · 3 min de leitura
Blocos de construção geométricos conectados por linhas de dados verdes, com um estetoscópio estilizado

Uma API pode responder 200 OK e estar quebrada. O endpoint devolve uma lista vazia porque o banco não conectou, um JSON de erro com status de sucesso, ou dados de cache de três dias atrás. Monitorar API bem é verificar se ela funciona, não só se ela responde.

Os níveis de monitoramento

1. Está respondendo?

O básico: o endpoint responde dentro do tempo limite, com um código HTTP esperado. Pega queda de servidor, erro de DNS, certificado vencido e erros 502, 503 e 504.

2. Responde o que deveria?

Verifique o conteúdo. Procure uma palavra-chave ou trecho que só aparece quando a resposta é válida, por exemplo "status":"ok" ou um campo obrigatório. Também dá para verificar o contrário: alertar se aparecer "error".

3. Responde rápido?

Registre o tempo de resposta e alerte quando passar de um limite. APIs lentas derrubam aplicativos e integrações em cascata. Veja site lento também é site fora do ar.

4. As dependências estão bem?

Um endpoint de saúde que verifica banco, cache, fila e serviços externos dá uma visão mais profunda.

Crie um endpoint de saúde

Um /health bem feito é o melhor amigo do monitoramento:

GET /health

{
  "status": "ok",
  "db": "ok",
  "cache": "ok",
  "queue": "ok",
  "version": "2.14.3"
}

Boas práticas:

  • Responda 503 quando alguma dependência crítica falhar, para o monitoramento entender sem precisar ler o corpo.
  • Seja rápido: o health check não deve fazer consultas pesadas.
  • Não exponha dados sensíveis, como senhas, IPs internos ou mensagens de erro detalhadas.
  • Separe, se fizer sentido, um /health/live (o processo está vivo) e um /health/ready (pronto para receber tráfego).

Monitorando endpoints autenticados

Muitas rotas exigem token. Opções:

  • Crie um token de monitoramento com permissão só de leitura, em uma conta de teste.
  • Envie o token no cabeçalho Authorization configurado no monitor.
  • Troque o token periodicamente e nunca use credenciais de administrador.

No UptimePage, cada monitor HTTP aceita método (GET, POST, PUT e outros), cabeçalhos personalizados, corpo da requisição, códigos aceitos e verificação de palavra-chave, o que cobre a maioria dos cenários de API.

Testando fluxos com POST

Para endpoints que recebem dados, monte uma requisição de teste que não cause efeitos reais: um pedido em modo de simulação, uma cotação, uma validação. Evite criar registros de verdade a cada minuto.

O que monitorar primeiro

Comece pelo que mais dói quando cai:

  1. Autenticação (login, emissão de token).
  2. O endpoint principal do produto (pedidos, pagamentos, agendamentos).
  3. Webhooks que você recebe de parceiros (use heartbeat se eles devem chegar com frequência).
  4. Integrações das quais você depende (gateway de pagamento, envio de e-mail).

Evitando alertas falsos

  • Confirme a falha com uma nova checagem antes de alertar.
  • Use tempo limite compatível com o endpoint.
  • Não monitore endpoints com limite de taxa baixo a cada 30 segundos.
  • Veja mais em como acabar com o alarme falso.

Comunique quem usa a sua API

Se outras empresas dependem da sua API, mostre o estado dela em uma status page. Desenvolvedores verificam a status page antes de abrir um chamado.

Perguntas frequentes

Com que frequência devo checar uma API?

A cada 1 minuto para APIs críticas. Para APIs internas ou de baixo impacto, de 5 em 5 minutos é suficiente.

Monitoramento de API substitui testes automatizados?

Não. Testes verificam o comportamento antes do deploy; o monitoramento verifica, em produção, que continua funcionando. Os dois se completam.

Posso monitorar uma API GraphQL?

Pode. Faça um POST com uma consulta simples e verifique uma palavra-chave na resposta, já que GraphQL costuma responder 200 mesmo com erro.

#api#rest#monitoramento#health check#json

Saiba que caiu antes do seu cliente.

Monitore sites, APIs e servidores a cada 30 segundos, receba o alerta onde estiver e mostre uma status page aos seus clientes. 5 monitores grátis, sem cartão.

Começar grátis