API Pública do CRM
Integre o Vendee a qualquer ferramenta REST — entrada de leads, leitura de dados e gestão de negócios via API Key.
A API Pública do Vendee permite que sistemas externos — landing pages, formulários, plataformas de automação (Make, n8n, Zapier) e agentes de IA — conversem com o seu CRM usando requisições HTTP simples, autenticadas por uma API Key.
Tudo na API é escopado por workspace: cada API Key pertence a um workspace e só enxerga os dados daquele workspace. Não há como uma chave acessar dados de outro cliente.
Base URL. Os endpoints são funções na infraestrutura Supabase do seu projeto. A URL
base tem o formato https://<seu-projeto>.supabase.co/functions/v1. Ao longo da
documentação ela aparece como {BASE_URL} — substitua pelo host do seu projeto. Cada
recurso é uma função: api-v1-leads, api-v1-deals, api-v1-contacts,
api-v1-companies, api-v1-pipelines.
Por onde começar
Quickstart
Gere uma chave e crie seu primeiro lead com um curl.
Referência
Autenticação, chaves, erros e todos os endpoints.
Webhooks
Receba eventos do CRM em tempo real (em breve).
Changelog
Histórico de versões e mudanças de contrato.
O que dá para fazer
- Entrada de leads — envie um lead de um formulário externo e o CRM cria empresa,
contato e negócio automaticamente (
POSTemapi-v1-leads). - Leitura — liste e consulte negócios, contatos, empresas e pipelines.
- Gestão de negócios — crie e atualize negócios e contatos, e mova um negócio de etapa, marque como ganho ou perdido.
Convenções
- Autenticação: header
X-API-Key: vnd_...em toda requisição. - Formato: JSON em request e response (
Content-Type: application/json). - Nomes de campo:
snake_caseem inglês (first_name,recurring_value). - Valores de enum: em português (
status: "ganho"). - Erros: sempre no envelope
{ "error": { "code": "...", "message": "..." } }, com a mensagem em português.