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.
Webhooks
- Webhooks — assinatura de eventos com entrega assinada (HMAC), régua de reenvio e histórico de entregas. Veja Webhooks.
Mudanças de agosto de 2026
Nenhuma quebra de contrato — tudo abaixo é acréscimo compatível.
- Cinco eventos novos de webhook.
deal.created,contact.createdelead.receivedpassaram a ser emitidos de verdade (constavam no catálogo e nunca disparavam), eproposal.accepted/proposal.rejectedtornaram-se assináveis. O catálogo vai de 7 para 12 eventos. - As ações de negócio pela API agora disparam webhook.
POST /api-v1-deals/:id/move-stage,/wine/loseemitemdeal.stage_changed,deal.wonedeal.lost— antes só a movimentação feita pelo app disparava. A emissão é best-effort: uma falha ao enfileirar nunca altera a resposta da API, e o retorno antecipado de/wine/loseem negócio já fechado continua idempotente, sem duplicar evento. - Histórico de entregas no app. Em Configurações › API e Integrações há uma seção com os últimos 50 envios: evento, situação, resposta do seu servidor e quando — é onde se descobre por que um webhook parou de chegar.
- A tela de chaves abre mesmo com a API desligada, em modo somente leitura, para explicar o motivo. O acesso continua barrado no servidor: toda chave é verificada a cada uso.