Pular para conteúdo

APIs

Escopo real

A API REST do MVP é parcial. A maior parte do produto usa URLs Django e templates server-side; não existe uma API REST CRUD para todos os módulos.

Base e autenticação

  • Base REST: /api/v1/.
  • Token DRF: POST /api/v1/auth/token/.
  • Schema OpenAPI: /api/schema/.
  • Swagger UI: /api/docs/.
  • ReDoc: /api/redoc/.
  • As rotas web usam sessão e CSRF; a API usa autenticação configurada pelo Django REST Framework.

Recursos REST implementados

Recurso Prefixo Implementação
Contas /api/v1/contas/ ContaViewSet
Oportunidades /api/v1/oportunidades/ OportunidadeViewSet
Atividades /api/v1/atividades/ AtividadeViewSet

Os routers DRF fornecem as operações declaradas pelos respectivos viewsets, incluindo listagem, detalhe, criação, alteração e exclusão conforme as permissões de cada classe.

Módulos sem API REST própria

Contatos, leads, pipeline, tarefas, anotações, dashboards, auditoria e contas de acesso são consumidos pelas URLs Django do MVP. Suas rotas e contratos de tela estão documentados nas páginas funcionais.

Fora do contrato atual

Não há /api/v1/crm/ como prefixo global, JWT Bearer obrigatório, webhooks, GraphQL ou API pública para campanhas, propostas, relatórios e integrações externas.