Saltar para o conteúdo principal
v1.0.1

Correções pós-lançamento

Correção: PATCH em negócios ignorando stage_id quando pipeline_id é omitido: ao atualizar o stage de um negócio via PATCH /v1/deals/:id, omitir pipeline_id do body fazia o stage_id ser silenciosamente ignorado. O endpoint agora atualiza corretamente o stage quando apenas stage_id é fornecido, desde que o stage pertença ao pipeline atual do negócio.Melhoria: header X-RateLimit-Reset agora retorna Unix timestamp: anteriormente o header retornava os segundos restantes até o reset. Agora retorna o Unix timestamp do momento do reset, mais fácil de usar em lógica de countdown no cliente.
v1.0.0

Lançamento da API pública v1

A Vendaze API v1 está disponível para todos os desenvolvedores. Este é o lançamento inicial com suporte completo a OAuth 2.1 e o conjunto completo de recursos do CRM.

OAuth 2.1 Authorization Code flow

O sistema de autorização é construído sobre OAuth 2.1 com client_secret. Todas as trocas de token acontecem server-side. O client_secret nunca é retornado em nenhuma resposta da API: ele é entregue uma única vez via link seguro por e-mail que expira em 15 minutos.
  • GET /oauth/authorize: inicia o fluxo de autorização, redirecionando o usuário para a tela de consentimento da Vendaze
  • POST /oauth/token: troca um authorization code por access_token e refresh_token, ou renova um access_token expirado usando um refresh_token
  • POST /oauth/revoke: invalida imediatamente um access_token e seu grant de autorização associado
  • POST /v1/auth/register-app: registra um novo app integrador e dispara o e-mail de entrega de credenciais (endpoint público, sem autenticação)
  • POST /v1/auth/rotate-app: rotaciona o client_secret de um app existente, invalidando o secret anterior imediatamente e enviando um novo link de credenciais para o e-mail cadastrado

Recursos disponíveis na v1

RecursoEscoposOperações
Peoplepeople:read, people:writeCRUD completo
Companiescompanies:read, companies:writeCRUD completo
Dealsdeals:read, deals:writeCRUD completo
Cada recurso suporta POST (criar), GET /:id (ler por ID), PATCH /:id (atualizar) e DELETE /:id (soft delete). Não há endpoints de listagem na v1.

Idempotência

POST /v1/people, POST /v1/companies e POST /v1/deals suportam o header Idempotency-Key. Chaves são armazenadas por 24 horas. Enviar a mesma chave com o mesmo body retorna a resposta original sem reprocessar. Enviar a mesma chave com body diferente retorna 422 com código idempotency_conflict.

Webhooks

Proprietários de workspace podem configurar endpoints de webhook no painel da Vendaze. Eventos são assinados com HMAC-SHA256 usando um secret por endpoint. A entrega usa semântica at-least-once com 5 tentativas em caso de falha. Eventos disponíveis no lançamento: person.created, person.updated, company.created, company.updated, deal.created, deal.updated, activity.created, task.created, task.updated, product.created.

MCP Server

O servidor MCP da Vendaze está disponível em https://api.vendaze.com/mcp para integração com ferramentas de IA como Claude, Cursor e GitHub Copilot. O MCP server usa a mesma autorização OAuth 2.1 da API REST. Veja a documentação de IA e Automações para instruções de configuração.

SDKs

Nenhum SDK oficial está disponível neste momento. A API segue padrões REST e HTTP convencionais e funciona com qualquer cliente HTTP. SDKs da comunidade são bem-vindos.