Pular para o conteúdo principal

Como testar

Dá para testar a AI Web Push API sem escrever código: importando a coleção do Postman, entregando o arquivo OpenAPI a uma IA para ela escrever a integração, ou chamando direto com curl. Em todas você precisa da chave da API.

Antes de testar​

  • Tenha a chave do site em mãos (onde pegar).
  • O site precisa ter inscritos: GET /topics só lista tópicos com pelo menos um inscrito, e uma campanha sem público não tem para quem ir.
  • Para não disparar notificação de verdade enquanto testa, crie campanhas com "status": "draft": elas ficam salvas, aparecem em POST /campaigns e podem ser excluídas com DELETE /campaign/{campaignId}.

Postman​

  1. Baixe a coleção do Postman.
  2. No Postman, clique em Import e escolha o arquivo.
  3. Abra a coleção, vá em Variables e preencha token com a sua chave. A variável baseUrl já vem pronta.
  4. Rode GET /topics.

A coleção traz os seis métodos, cada um já com o header de autenticação, e os dois POST vêm com um corpo de exemplo preenchido.

Com uma IA (ChatGPT, Claude, Cursor e afins)​

Baixe o arquivo OpenAPI e anexe na conversa. Ele descreve os endpoints, os campos, os limites e os exemplos, então a IA consegue escrever o código de integração sem você explicar a API.

Pedidos que funcionam bem:

Anexei o arquivo OpenAPI da AI Web Push API. Escreva uma função em Node.js que cria uma campanha agendada e depois consulta os resultados dela.

Com o OpenAPI anexado, escreva um script em Python que lista todas as campanhas enviadas em agosto, percorrendo a paginação com cursor até hasMore vir false, e soma os cliques.

O mesmo arquivo pode ser importado em qualquer ferramenta que leia OpenAPI 3.1. Se o agente preferir texto puro, a documentação inteira também está em /llms-full.txt.

Com curl​

curl https://api.aiwebpush.com/v2/topics \
  -H "Authorization: SUA_CHAVE"
curl -X POST https://api.aiwebpush.com/v2/campaigns \
  -H "Authorization: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status":["sent"],"limit":10}'

Cada método da Referência traz o curl pronto e o JSON de request e response. Para fluxos completos (enviar agora, agendar, paginar, cancelar), veja Receitas.

Última atualização em