Changelog
Histórico de versões e mudanças de contrato da API Pública do Vendee.
A API segue versionamento na URL (api-v1-*). Mudanças que quebram contrato sobem a versão
major; acréscimos compatíveis (novos campos opcionais) podem entrar sem nova versão.
v1
Primeira versão pública da API REST do CRM Vendee. Recursos disponíveis:
- Leads —
POST /api-v1-leads: entrada de lead com criação automática de empresa, contato e negócio; idempotência porexternal_id. - Negócios —
GET /api-v1-deals(lista com filtros e paginação),GET /api-v1-deals/:id(com contato, empresa e última atividade),POST/PATCH, e as açõesmove-stage,winelose. - Contatos —
GET /api-v1-contacts(lista + detalhe),POST/PATCH. - Empresas —
GET /api-v1-companies(lista + detalhe),POST/PATCH. - Pipelines —
GET /api-v1-pipelines: funis e etapas do workspace. - Autenticação por API Key (
X-API-Key: vnd_...) com escopos por recurso e isolamento por workspace. - Gestão de chaves (criar / listar / revogar) pelo app, restrita a administradores e gestores.
Em finalização
- Webhooks — assinatura de eventos com entrega assinada (HMAC). Disponível apenas no ambiente de testes; contrato sujeito a mudança. Veja Webhooks.