Pular para conteúdo
  • Marcelo Areco reviewers: [] created: 2026-07-02 updated: 2026-07-02 tags:
  • crm
  • api
  • rest
  • openapi

APIs

Objetivo

Definir o padrão oficial das APIs do CoreFlow CRM.

Todas as funcionalidades do CRM deverão ser expostas através de APIs REST versionadas, documentadas e seguras.

Arquitetura

Padrão:

  • REST
  • JSON
  • UTF-8
  • HTTPS
  • OpenAPI 3.x

Base URL

/api/v1/crm/

Autenticação

Obrigatória.

Método:

  • JWT Bearer Token

Exemplo:

Authorization: Bearer <token>

Content-Type

application/json

Versionamento

/api/v1/

Mudanças incompatíveis deverão gerar nova versão.

Recursos

Leads

GET    /crm/leads
GET    /crm/leads/{id}
POST   /crm/leads
PUT    /crm/leads/{id}
PATCH  /crm/leads/{id}
DELETE /crm/leads/{id}
POST   /crm/leads/{id}/convert

Contacts

GET
POST
PUT
PATCH
DELETE

Accounts

GET
POST
PUT
PATCH
DELETE

Opportunities

GET
POST
PUT
PATCH
DELETE

Activities

GET
POST
PUT
PATCH
DELETE

Proposals

GET
POST
PUT
PATCH
DELETE

Campaigns

GET
POST
PUT
PATCH
DELETE

Customer Success

GET
POST
PUT
PATCH
DELETE

Paginação

Padrão:

?page=1

&page_size=20

Ordenação

?ordering=name

?ordering=-created_at

Filtros

Exemplos:

?status=active

?responsible=uuid

?company=uuid

?created_after=2026-01-01

Busca

?search=marcelo

Respostas

Sucesso

200 OK

201 Created

204 No Content

Erros

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

422 Unprocessable Entity

500 Internal Server Error

Estrutura

{
  "success": true,
  "data": {},
  "message": "",
  "errors": []
}

Uploads

Uploads serão realizados através do serviço Core Files.

Auditoria

Todas as operações deverão registrar:

  • usuário
  • empresa
  • data
  • IP
  • ação

Segurança

Obrigatório:

  • HTTPS
  • JWT
  • RBAC
  • Rate Limit
  • Validação de Payload
  • Auditoria

OpenAPI

Toda API deverá possuir:

  • descrição
  • exemplos
  • schemas
  • códigos HTTP
  • autenticação
  • payloads

Eventos

Operações poderão publicar:

  • LeadCreated
  • OpportunityWon
  • ProposalGenerated
  • CustomerCreated

Integrações

  • Core
  • ERP
  • Finance
  • RH
  • BI
  • AI
  • Webhooks

Performance

Objetivos:

  • Tempo médio inferior a 300 ms
  • Paginação obrigatória
  • Compressão HTTP
  • Cache quando aplicável

Objetivo Final

Disponibilizar APIs consistentes, seguras, versionadas e preparadas para integração com toda a CoreFlow Platform e sistemas externos.