uptimescout
Obter uma chave de API

Guia do UptimeScout

Como integrar uma API de disponibilidade de serviços com o UptimeScout

Crie um painel de disponibilidade que mantenha horários e incertezas visíveis, em vez de reduzir cada resposta a um ponto colorido.

Conectores de fibra e rede num painel de servidores.
Ilustração editorial gerada por IA

Descubra os IDs dos serviços antes de consultá-los

Comece pelo endpoint de serviços para encontrar o identificador usado pelo UptimeScout. Nem sempre o nome de uma marca legível por pessoas corresponde ao identificador da API. Mantenha o ID e a região na configuração do aplicativo para que as solicitações de status e histórico se refiram ao mesmo serviço.

Obtenha uma licença elegível pela Evelode e mantenha-a em um segredo no servidor ou em uma variável de ambiente. Não inclua uma chave paga em JavaScript executado no navegador, em um repositório público, em uma captura de tela ou em um URL.

Envie uma solicitação de status autenticada

Defina EVELODE_LICENSE_KEY no seu ambiente antes de executar o exemplo. Este exemplo solicita observações do GitHub para US; é um modelo de solicitação, não uma afirmação sobre o status atual do GitHub.

curl -G https://api.uptimescout.com/v1/status \
  --data-urlencode "service=github" \
  --data-urlencode "region=US" \
  -H "Authorization: Bearer $EVELODE_LICENSE_KEY"

Interprete a resposta antes de exibi-la

Uma resposta de transporte bem-sucedida e o sinal de disponibilidade do serviço são camadas distintas. Primeiro, valide o status HTTP e o envelope da resposta. Depois, confira service.status, service.observed_at e service.stale. Mantenha unknown e stale visíveis, em vez de tratá-los silenciosamente como operational.

Armazene a região junto com o horário da observação. Se sua interface for atualizada periodicamente, identifique separadamente o horário da observação e o horário em que seu aplicativo buscou a resposta. Uma resposta HTTP recente pode descrever uma observação mais antiga.

Planeje o volume de solicitações e trate os limites

Use o endpoint `statuses` quando um lote for adequado ao seu fluxo de trabalho e consulte o plano selecionado para saber o tamanho máximo do lote. O limite de solicitações e o número de solicitações por minuto são limites diferentes. O acesso por REST, SDK e MCP compartilha a mesma contabilização licenciada.

Para HTTP 429, respeite Retry-After e evite uma sequência de novas tentativas imediatas. Use novas tentativas limitadas, com intervalos crescentes, para falhas temporárias; não repita indefinidamente erros de autenticação ou de parâmetros inválidos. Renovações e mudanças de plano atualizam o limite licenciado; não há renovação no primeiro dia do mês civil.

Teste os casos incertos antes da implantação

Teste um serviço conhecido, um ID desconhecido, uma chave ausente, parâmetros inválidos e uma observação desatualizada ou ausente. Verifique se esses casos geram mensagens úteis na sua interface. Não inclua resultados completos de diagnóstico em registros públicos quando contiverem credenciais ou informações da conta.

A documentação da API contém os sete métodos públicos e o esquema OpenAPI. O jsonscraper disponibiliza links para os SDKs de Python, Node.js, PHP, Go, Java e .NET. Uma biblioteca cliente simplifica o transporte, mas seu aplicativo ainda precisa de uma política para interpretar a incerteza.

Conteúdo revisado em 18 de novembro de 2026.

Markdown

REST / MCP / SDK

Verifique um serviço ou integre a API

Use o diretório de serviços para consultar um sinal regional atual e a documentação para criar uma integração reproduzível.

Diretório de serviçosDocumentação da API