# AI Web Push API

> A AI Web Push API é a API HTTP da plataforma AI Web Push (aiwebpush.com) para criar, agendar, listar, consultar e excluir campanhas de web push, segmentando por tópicos e países. Base URL: https://api.aiwebpush.com/v2. Autenticação: header Authorization com a chave da API do site, sem prefixo Bearer. Requisições e respostas em JSON; datas em UTC (ISO 8601); erros sempre no formato {"message": "..."}. O acesso à API depende do plano da conta.

## Documentação

- [Introdução à API de web push](https://docs.aiwebpush.com/api/): A AI Web Push API cria, agenda, lista e exclui campanhas de web push por HTTP, segmentando por tópicos e países. Base URL, convenções e primeira chamada.
- [Autenticação da API: chave por site](https://docs.aiwebpush.com/api/autenticacao/): Como obter a chave da AI Web Push API no painel, enviá-la no header Authorization (sem Bearer) e entender os erros 403, 404 e 400 ligados à autenticação.
- [Como testar a API: Postman, IA e curl](https://docs.aiwebpush.com/api/como-testar/): Três formas de testar a AI Web Push API em minutos — coleção Postman, arquivo OpenAPI anexado a ChatGPT, Claude ou Cursor, ou curl direto no terminal.
- [Receitas: fluxos prontos da API](https://docs.aiwebpush.com/api/receitas/): Fluxos ponta a ponta da AI Web Push API com curl e JSON — enviar agora, agendar, salvar rascunho, listar resultados, paginar com cursor e cancelar.
- [Erros e códigos de status da API](https://docs.aiwebpush.com/api/erros/): Formato de erro da AI Web Push API, o significado de 400, 403, 404, 409 e 500, como tratar cada um no código e a lista completa de mensagens de validação.
- [Limites e regras dos campos da API](https://docs.aiwebpush.com/api/limites/): Regras de cada campo da AI Web Push API — tamanhos de título e texto, URLs HTTPS, datas UTC, TTL em segundos, limit e cursor — e dicas para render mais.
- [Perguntas frequentes sobre a API](https://docs.aiwebpush.com/api/faq/): Respostas curtas sobre a AI Web Push API — quem pode usar, chave, tópicos e países, status, agendamento em UTC, TTL, paginação, exclusão e erros comuns.
- [Glossário da API de web push](https://docs.aiwebpush.com/api/glossario/): Definições dos termos da AI Web Push API — campanha, tópico, país, status, scheduleMode, TTL, cursor e as métricas cliques, impressões, CTR e ITS.
- [Changelog da API](https://docs.aiwebpush.com/api/changelog/): Histórico de mudanças da AI Web Push API v2 — novos endpoints, campos e correções, em ordem cronológica, com a data de cada alteração.

## Referência de endpoints

- [Criar campanha](https://docs.aiwebpush.com/api/reference/create-campaign/): `POST /campaign/create` — Cria uma campanha de web push: envia na hora, agenda para uma data futura ou salva como rascunho, com público segmentado por tópicos e países.
- [Listar campanhas](https://docs.aiwebpush.com/api/reference/list-campaigns/): `POST /campaigns` — Lista as campanhas do site com resultados de envio (`analytics`), filtros por período e status, e paginação por cursor.
- [Obter campanha](https://docs.aiwebpush.com/api/reference/get-campaign/): `GET /campaign/{campaignId}` — Consulta uma campanha de web push pelo ID e devolve todos os campos, incluindo os resultados de envio (`analytics`).
- [Excluir campanha](https://docs.aiwebpush.com/api/reference/delete-campaign/): `DELETE /campaign/{campaignId}` — Exclui uma campanha de web push que ainda não foi enviada: apaga rascunhos e cancela agendamentos.
- [Listar tópicos](https://docs.aiwebpush.com/api/reference/list-topics/): `GET /topics` — Lista os tópicos de interesse do site que têm pelo menos um inscrito, do mais popular para o menos popular, com a quantidade de inscritos de cada um.
- [Listar países](https://docs.aiwebpush.com/api/reference/list-countries/): `GET /countries` — Lista os países que têm inscritos no site, com a quantidade de inscritos de cada um, no mesmo formato de `/topics`.

## Recursos

- [Portal de documentação](https://docs.aiwebpush.com/): índice das seções (API e demais sistemas da AI Web Push)
- [Contrato OpenAPI 3.1 em YAML](https://docs.aiwebpush.com/openapi/ai-web-push.yaml): descrição completa e atual da API, importável em Postman, geradores de cliente e assistentes de IA
- [Coleção Postman](https://docs.aiwebpush.com/downloads/ai-web-push.postman_collection.json): os seis métodos prontos com autenticação e corpos de exemplo
- [Documentação completa em texto puro](https://docs.aiwebpush.com/llms-full.txt): todas as páginas e endpoints num arquivo só
- [Painel AI Web Push](https://app.aiwebpush.com): onde a chave da API é obtida (Settings > site > Chave da API)
- [Site AI Web Push](https://aiwebpush.com): produto, planos e contato (contato@aiwebpush.com)

## Optional

- [Changelog](https://docs.aiwebpush.com/api/changelog/): histórico datado de mudanças da API