Pular para o conteúdo principal
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.
Novo na iZap? Instale um cliente tipado com pip install izap ou npm install @izapai/sdk — SDKs. Chame a mesma API pelo terminal com a CLI. Ou deixe o assistente de configuração montar REST, MCP, webhooks ou SSE na sua stack.

Recursos

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