Pular para o conteúdo

Visão geral da API

A API HTTP da apiwpp: endereço base, autenticação por chave, formato dos erros e a lista de todas as operações e eventos de webhook.

Ver em Markdown

O endereço base da API é https://api.apiwpp.com. As requisições e as respostas são JSON: envie Content-Type: application/json nas requisições com corpo.

Autenticação. Toda operação recebe uma chave de API (wag_live_…), como Authorization: Bearer <chave> ou X-Api-Key: <chave>. A chave pertence a um projeto e só alcança os recursos dele. Cada operação indica o escopo de que a chave precisa (veja Escopos); só o download de mídia dispensa a chave, porque a URL assinada é a credencial. Detalhes em Autenticação.

Erros respondem { "error": "…" } com o status HTTP; alguns acrescentam code (como number_limit_reached) e message, e a validação do corpo responde 400 com code: "FST_ERR_VALIDATION". Decida pelo status e pelo code, nunca pelo texto. 401 é chave ausente, desconhecida, revogada ou expirada; 403 é permissão que falta (um escopo, citado na mensagem, ou um recurso do plano); um recurso de outra pessoa responde 404, exatamente como um que não existe. Veja Erros e Códigos de erro.

Limites. Por padrão, cada IP de origem faz até 600 requisições por minuto, e, depois de 20 chaves erradas em 5 minutos, as próximas chaves erradas desse IP também recebem 429 (a chave certa continua aceita); os dois limites respondem com Retry-After. Os envios entram numa fila com ritmo controlado por número: POST /connections/{id}/send responde 202 com o job. Todos os números estão em Limites.

Listas. Os registros (GET /messages e GET /webhooks/deliveries) devolvem os itens mais recentes primeiro, sem paginação por cursor: limit vale 60 por padrão e no máximo 200.

Conexões

Mensagens

Projetos

Contatos

Templates

Chaves de API

Conta

Uso

Registros

Mídia

Webhooks

Os eventos chegam por POST ao webhookBaseUrl do projeto.

Esta página ajudou? · Atualizado em 29 set 2026