Pular para o conteúdo principal

AI Web Push API

A AI Web Push API é a API HTTP da plataforma AI Web Push para criar, agendar, listar, consultar e excluir campanhas de web push a partir do seu próprio sistema. Ela recebe e devolve JSON, autentica com a chave do site e segmenta o público pelos mesmos tópicos e países que aparecem no painel.

Todas as chamadas usam a mesma base:

https://api.aiwebpush.com/v2

Como a API se encaixa na AI Web Push​

A AI Web Push é uma plataforma de web push para sites de conteúdo. O fluxo completo tem três partes, e a API cuida só da última:

  1. Inscritos — os visitantes entram na base pelo plugin WordPress da AI Web Push instalado no site, quando aceitam receber notificações.
  2. Tópicos — a IA da plataforma classifica o conteúdo que cada inscrito lê e o agrupa em tópicos de interesse (por exemplo tecnologia, esportes). O dono do site também pode cadastrar e ajustar tópicos no painel. Além dos tópicos, cada inscrito conta num país, listado em /countries.
  3. Campanhas — uma campanha é uma notificação (título, texto, link, ícone, imagem, botão) enviada para um ou mais tópicos e/ou países, na hora ou agendada. É aqui que a API entra: ela cria, consulta e exclui campanhas e lê os resultados de envio.

Tudo que a API faz também existe no painel app.aiwebpush.com. Use a API quando quiser que o envio aconteça de dentro do seu CMS, de uma automação de marketing, de um CRM ou de qualquer rotina sua, sem abrir o painel.

Disponibilidade por plano​

O acesso à API, e aos relatórios de campanha via API, está disponível em planos específicos da AI Web Push. Quando a conta não tem o recurso liberado, os métodos de campanha respondem 403 com { "message": "This plan does not have permission to..." }. Já GET /topics e GET /countries respondem 200 com uma lista vazia — igual a um site que ainda não tem inscritos. Os planos estão em aiwebpush.com; em caso de dúvida, fale com contato@aiwebpush.com.

Métodos​

MétodoCaminhoO que faz
POST/campaign/createCria uma campanha (envia agora, agenda ou salva rascunho)
POST/campaignsLista campanhas com resultados de envio, filtros e paginação
GET/campaign/{campaignId}Consulta uma campanha, com analytics
DELETE/campaign/{campaignId}Exclui uma campanha não enviada (rascunho ou agendada)
GET/topicsLista os tópicos do site que têm inscritos
GET/countriesLista os países que têm inscritos

Convenções​

  • A chave da API vai no header Authorization, sem prefixo Bearer. Veja Autenticação.
  • Nos POST, envie Content-Type: application/json.
  • Datas usam UTC no formato ISO 8601: 2025-05-02T18:30:00Z.
  • Erro sempre responde { "message": "..." }, seja qual for o status. Veja Erros.
  • A chave é vinculada a um site. Toda chamada só alcança as campanhas, os tópicos e os países desse site.
  • Nomes de tópico e de país vêm sempre em minúsculas, e países com o prefixo country__ (ex.: country__brazil).

Fluxo típico de integração​

  1. Pegue a chave do site no painel e guarde no servidor (Autenticação).
  2. Chame GET /topics (e, se for segmentar por país, GET /countries) para descobrir os nomes exatos que o site usa.
  3. Crie a campanha com POST /campaign/create, escolhendo entre enviar agora, agendar ou salvar rascunho. Guarde o id devolvido.
  4. Acompanhe o resultado com GET /campaign/{campaignId} ou liste várias de uma vez com POST /campaigns (cliques, impressões, CTR e ITS).

Os quatro passos estão prontos, com curl e JSON, em Receitas.

Primeira chamada​

curl https://api.aiwebpush.com/v2/topics \
  -H "Authorization: SUA_CHAVE"
[
  { "name": "tecnologia", "users": 1840 },
  { "name": "esportes", "users": 920 }
]

Se a lista voltar, a chave está funcionando. A partir daí, use a Referência para montar as demais chamadas, ou siga por Como testar para usar Postman, uma IA ou curl.

Última atualização em