API para desenvolvedores

Envie notificações push do seu backend.

A API do Pocket Alert envia uma notificação push para o seu celular com uma única requisição POST autenticada. Dispare-a a partir de Node, Python, PHP ou Go — title, message, nível de prioridade — e ela chega ao seu iPhone ou Android quase instantaneamente.

Push em <1sREST puroNode · Python · Go · PHPAtualizado em
Recursos

Notificações push, a uma requisição de distância

A API alimenta todos os alertas do Pocket Alert. Conecte-a ao seu backend com uma única requisição.

REST puro, sem SDK

Um único POST autenticado envia uma notificação push a partir do cliente HTTP que você já usa. Sem SDK, fila ou broker envolvidos.

Qualquer linguagem

Node, Python, PHP, Go e Ruby podem disparar uma notificação push do Pocket Alert.

Autenticação por chave

Sua chave de API viaja no cabeçalho Token sobre HTTPS. Crie, defina o escopo e rotacione chaves no seu próprio ritmo.

Controle total

Direcione com application_id e tenha como alvo um único device_id, ou omita-o para alcançar todos os dispositivos, tudo em uma só chamada.

Entrega em menos de um segundo

As notificações chegam ao seu iPhone ou Android em bem menos de um segundo, rápido o bastante para alimentar alertas em tempo real do seu backend.

Pronto para CLI e webhook

A mesma API alimenta a CLI e os webhooks. Comece com código e adicione qualquer um dos dois depois.

Primeiros passos

Três passos para sua primeira notificação push pela API

1

Obtenha uma chave de API

Crie uma chave de API na página Chaves de API e guarde-a em uma variável de ambiente.

2

Envie a requisição

Envie um title e uma message em JSON para o endpoint de mensagens, com a chave no cabeçalho Token.

3

Pronto, no ar

Seu celular vibra em menos de um segundo. Adicione o direcionamento para aplicativos e dispositivos conforme suas necessidades crescerem.

Envie sua primeira notificação pela API

1. Obtenha uma chave de API

Crie uma chave na página Chaves de API e envie-a no cabeçalho Token em cada requisição.

2. Faça um POST de uma mensagem

curl -X POST 'https://api.pocketalert.app/v1/messages' \
  -H 'Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Order shipped","message":"Order #1024 is on its way","application_id":"qm47b9pzxzxg"}'

3. A partir do seu código

Chame a API sempre que um endpoint apresentar erro ou um evento personalizado acontecer, por exemplo após uma verificação de integridade falhar ou um novo pedido ser feito:

await fetch("https://api.pocketalert.app/v1/messages", {
  method: "POST",
  headers: { Token: process.env.POCKETALERT_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    title: "API health check failed",
    message: "GET /v1/orders returned 500",
    application_id: "qm47b9pzxzxg",
    level: "high",
  }),
});

A documentação de primeiros passos completa cobre o direcionamento para aplicativos e dispositivos.

FAQ

Dúvidas respondidas

Faça um POST para a API de mensagens do Pocket Alert com sua chave no cabeçalho Token e um corpo JSON contendo o title e a message. A notificação chega no seu celular na hora.

Autentique-se com uma chave de API da página de Configurações, enviada no cabeçalho Token sobre HTTPS. Crie e rotacione chaves sempre que precisar e defina o escopo dos alertas por aplicativo.

Qualquer linguagem que faça requisições HTTP funciona: Node, Python, PHP, Go, Ruby e Rust. Não há nada para instalar, apenas uma chamada REST simples a partir do cliente HTTP que você já usa.

Defina o title e a message, direcione para um aplicativo específico com application_id, tenha como alvo um único dispositivo com device_id (ou omita-o para alcançar todos os dispositivos) e defina a prioridade com level, de silencioso a crítico. Uma mensagem crítica ignora o modo Não perturbe no Android e atravessa o Foco no iPhone.

Sim. A CLI do Pocket Alert encapsula a mesma API para scripts e CI. Se preferir não escrever código, crie um webhook e aponte um serviço para a URL de recebimento dele.

Uma requisição, direto no seu celular.

Crie uma chave de API e envie sua primeira notificação push a partir do seu backend.