API do ZapyFlow
Uma API REST para tudo o que o seu workspace faz — conversas, pedidos, agendamentos, contatos, CRM, campanhas e canais. 210 operações, 48 escopos, versão 2026-10-12.
Endereço base
text
https://api.zapyflow.com.brO contrato legível por máquina fica em /openapi.json (OpenAPI 3.1) e é gerado do servidor em execução — não escrito à mão.
Sua primeira chamada
Crie uma chave no painel, em Desenvolvedores → Chaves de API. O segredo aparece uma vez só, no momento da criação. Conceda apenas os escopos de que a integração precisa.
bash
curl https://api.zapyflow.com.br/api/conversations \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"O que uma chave é — e o que não é
Uma chave é um principal autenticado de um workspace, não uma personificação de quem a criou. Três consequências que vale conhecer antes de construir:
| Regra | O que isso significa para você |
|---|---|
| A chave nunca excede quem a criou | A permissão efetiva é a interseção dos escopos da chave com as capacidades do papel de quem a criou. Se essa pessoa for rebaixada, a chave estreita na requisição seguinte. |
| Rotas de conta pessoal são fechadas a toda chave | Perfil, senha, e-mail, sessões e exclusão de conta não são alcançáveis por chave — inclusive pelas chaves criadas antes de os escopos existirem. |
| Chave pertence a um workspace | Uma chave nunca lê nem escreve dado de outro workspace, quaisquer que sejam os ids que você passar. |
Próximos passos
- Autenticação — cabeçalhos, o que um 401 quer dizer, rotação de chave
- Escopos — a lista completa, gerada da tabela de autorização do servidor
- Webhooks — esquema de assinatura, retentativas e vetores de resposta conhecida