Documentação da API.

A API do AI Web Push permite consultar os tópicos associados ao seu site e criar campanhas de notificação push por meio de requisições HTTP. Cada site possui sua própria chave de API, que deve permanecer privada.

1. Acesse Configurações → API no painel: app.aiwebpush.com/settings
2. Selecione o site que deseja usar a API.
3. Copie a chave exibida e guarde-a em local seguro — nunca exponha em front-end ou repositórios públicos.

Retorna um array com cada tópico e a quantidade de usuários inscritos.

Exemplo (cURL)

curl --request GET \
  --url https://api.aiwebpush.com/v2/topics \
  --header "Content-Type: application/json" \
  --header "Authorization: abcd1234efgh5678"

Resposta · 200 OK

[
  { "name": "esportes",  "users": 542 },
  { "name": "negocios",  "users": 187 },
  { "name": "cinema",    "users": 95  }
]

Retorna um array com cada país e a quantidade de usuários inscritos.

Resposta · 200 OK

[
  { "name": "country__Brazil",    "users": 6552 },
  { "name": "country__Mexico",    "users": 3265 },
  { "name": "country__Argentina", "users": 214  }
]

Cria uma nova campanha de push. Envie um objeto JSON com os campos abaixo:

Exemplo (cURL)

curl --request POST \
  --url https://api.aiwebpush.com/v2/campaign/create \
  --header "Content-Type: application/json" \
  --header "Authorization: abcd1234efgh5678" \
  --data '{
    "title": "Lançamento da Semana",
    "body": "Confira os bastidores do nosso novo produto!",
    "status": "published",
    "scheduleMode": "now",
    "scheduleDate": null,
    "icon": "https://exemplo.com/media/icon-96x96.png",
    "image": "https://exemplo.com/media/banner-produto.webp",
    "topics": ["esportes", "negocios"],
    "countries": ["country__Brazil"],
    "link": "https://exemplo.com/blog/lancamento",
    "callToAction": "Ver detalhes",
    "utmSource": "api-doc",
    "utmMedium": "push",
    "utmCampaign": "lancamento-semana"
  }'

Resposta · 200 OK

{ "Id": "c_01h9y4c3x1z7p3r5" }