API REST - iZap Developers

A API REST da iZap tem raiz em /api/v1 em cada ambiente e é autenticada com um personal access token ou OAuth 2.0 (veja Autenticação). Explore o schema completo de requisição e resposta — e faça chamadas ao vivo — na seção Endpoints desta aba.

Ambiente	Origem
Produção	`https://api.izap.ai`
Staging	`https://api-staging.izap.ai`

Novo na iZap? O assistente de configuração monta um cliente funcional (REST, MCP, webhooks ou SSE) na sua stack com um único comando.

Recursos

Recurso	Caminho	Finalidade
Auth	`/oauth/*`	OAuth 2.0 para aplicações de terceiros; veja Autenticação
Tokens de API	`/api/v1/me/api-tokens/*`	Criar, listar e revogar personal access tokens
Empresas	`/api/v1/businesses/*`	Configuração de tenant, horários, menus e biblioteca de mídia
Chats	`/api/v1/chats/*`	Leitura/escrita de conversas e envio
Templates de WhatsApp	`/api/v1/whatsapp_templates/*`	Gerenciar e sincronizar templates de mensagem
Transmissões	`/api/v1/transmissions/*`	Transmissões (broadcasts) de WhatsApp
Webhooks	`/api/v1/webhook-endpoints/*`	Registre uma URL para receber eventos, veja Webhooks

Convenções

Versionamento — a API está montada sob /api/v1; mudanças que quebram compatibilidade migram para um novo caminho de versão.
Auth — envie Authorization: Bearer <token> em cada requisição.
Content type — corpos de requisição e resposta em JSON.

Status

Verifique a saúde da plataforma em tempo real na página de status. O endpoint /health permanece disponível como uma sonda de disponibilidade em JSON, legível por máquina, para seu próprio monitoramento.

Modelo de erros

Status	Significado
`401`	Token ausente/expirado — reautentique-se.
`422`	Erro de validação — verifique o corpo da requisição.
`400`	Conflito de domínio ou de dados.
`500`	Erro de servidor.