Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

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 os principais recursos do CRM.

OAuth 2.1 com PKCE obrigatório

  • GET /oauth/authorize: inicia o fluxo de autorização
  • POST /oauth/token: troca de authorization code por tokens e renovação via refresh token
  • POST /oauth/revoke: revogação de access token ou refresh token
  • POST /v1/auth/register-app: registro de novo app integrador (público)
PKCE com code_challenge_method=S256 é obrigatório em todos os fluxos. Plain PKCE não é aceito.

Recursos disponíveis na v1

RecursoEscoposOperações
Peoplepeople:read, people:writeCRUD completo
Companiescompanies:read, companies:writeCRUD completo
Dealsdeals:read, deals:writeCRUD completo
Taskstasks:read, tasks:writeCRUD completo
Activitiesescopos da entidade vinculadaCreate, Read, Delete
Productsdeals:write para escritaCRUD completo
Tagsqualquer escopo de escritaCRUD completo
Listspeople:read/write ou companies:read/writeCRUD completo
Custom Fieldsescopos correspondentesCRUD completo

Paginação e filtros

Todos os endpoints de listagem suportam paginação com page, per_page (máximo 100), order_by e order. Filtros de texto, data, tag e campos adicionais disponíveis em todos os recursos.

Rate limiting

  • GET: 1.000 req/min por client_id
  • POST/PATCH: 200 req/min por client_id
  • DELETE: 100 req/min por client_id
  • Endpoints OAuth: 20 req/min por IP
Headers X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset incluídos em todas as respostas.

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. Veja a documentação de IA e Automações para detalhes.

SDKs

Nenhum SDK oficial está disponível neste momento. A API segue padrões REST e HTTP convencionais, funcionando com qualquer cliente HTTP.