Pular para o conteúdo principal
A API REST da iZap tem raiz em /api/v1 em cada ambiente e é autenticada com OAuth 2.0 / JWT (veja Autenticação). Explore o schema completo de requisição e resposta — e faça chamadas ao vivo — na seção Endpoints desta aba.
AmbienteOrigem
Produçãohttps://api.izap.ai
Staginghttps://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

RecursoCaminhoFinalidade
Auth/api/v1/auth/*, /oauth/*Login com JWT e OAuth 2.0
Empresas/api/v1/businesses/*Configuração de tenant e membros
Chats/api/v1/chats/*Leitura/escrita de conversas e envio
Agendamento/api/v1/scheduling/*Clientes, serviços e reservas
Templates de WhatsApp/api/v1/whatsapp_templates/*Gerenciar e sincronizar templates de mensagem
Transmissões/api/v1/transmissions/*Transmissões (broadcasts) de WhatsApp

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 <jwt> em cada requisição.
  • Content type — corpos de requisição e resposta em JSON, exceto na autenticação, que usa form-encoded.

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

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