Primeiros passos
Comece a usar o PulseAPI em menos de 5 minutos.
Cadastrar-se
Crie sua conta em ./signup.
Adicione seu primeiro endpoint
Após fazer login, você verá o assistente de integração. Adicione seu primeiro endpoint:
- Insira a URL da sua API (ex.: https://api.example.com/health)
- Escolha o método HTTP (GET, POST, etc.)
- Defina o intervalo de verificação (1–60 minutos)
- Configure o tempo limite (5–60 segundos)
{
"url": "https://api.example.com/health",
"method": "GET",
"checkInterval": 60,
"timeout": 10
}Configurar uma página de status
Crie uma página de status pública para compartilhar a disponibilidade com seus usuários. Vá para Dashboard > Página de status.
- Escolha um slug único para sua URL
- Personalize com seu logo, cores e nome da empresa
- Selecione quais endpoints exibir
- Opcionalmente adicione um domínio personalizado (ex. status.suaempresa.com)
Configure alertas
PulseAPI envia alertas automaticamente para:
Todos os alertas vão para seu email de cadastro. Configure webhooks e Telegram nas Configurações para canais adicionais.
Painel de monitoramento
Assim que seu endpoint for adicionado, o PulseAPI começa a monitorar imediatamente. Visualize:
- Status em tempo real (Operacional, Fora do ar, Degradado)
- Gráficos de tempo de resposta (últimos 7 dias)
- Porcentagem de uptime (janela móvel de 24h)
- Tabela de histórico de verificações (paginada, ordenável)
Use a API
Crie uma chave de API para acesso programático ao PulseAPI.
- Vá para Dashboard > Configurações > Chaves de API
- Clique em Criar, dê um nome e selecione os escopos (ex. endpoints:read, alerts:read)
- Copie a chave imediatamente -- ela é exibida apenas uma vez
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints
# Trigger a manual check
curl -X POST -H "Authorization: pk_live_abc123..." \
https://api.pulseapi.tech/endpoints/ENDPOINT_ID/checkConsulte a para a lista completa de endpoints.Referência da API
Precisa de ajuda?
Tem perguntas ou feedback? Envie um email para - respondemos a todas as mensagens.[email protected]