Visão da plataforma
A API do app da Antecipa Fácil expõe os recursos usados no produto para conectar cedentes, sacados, financiadores e times operacionais. O contrato público é REST/JSON e passa pelo APIM, que atua como gateway e repasse para o backend.
Domínios principais
Seção intitulada “Domínios principais”| Domínio | Papel na integração |
|---|---|
| Auth | Login, refresh de token, usuário atual e autenticação social/Microsoft quando aplicável. |
| Company | Empresas, papéis, usuários, contas bancárias, documentos, relacionamentos e permissões por contexto. |
| Quotation | Criação e manutenção de cotações, importação de notas, documentação e resumo da operação. |
| Marketplace | Publicação/consulta de títulos, lances, comissões, pagamentos, documentos e acompanhamento de atualização. |
| Titles | Listagens e consultas auxiliares de títulos, sacados e dados agregados. |
| Escrow Account | Contas escrow, boletos, extratos e statements. |
| Reports | Relatórios de clientes, vencimentos, maturidades e carteira. |
Modelo de contexto
Seção intitulada “Modelo de contexto”A maior parte dos endpoints operacionais recebe company_role_id. Esse identificador representa o vínculo entre usuário, empresa e papel da empresa na plataforma.
Fluxo recomendado:
- Autenticar usuário ou integração.
- Obter empresas disponíveis em
GET /api/company/v1/get-user-companies. - Selecionar o
company_role_idcorreto. - Chamar os recursos de empresa, cotação, marketplace, documentos ou relatórios.
Escopo do gateway
Seção intitulada “Escopo do gateway”O gateway público é:
https://api.antecipafacil.net.brO APIM opera como entrada única. O cliente externo não precisa conhecer pods, serviços internos ou hosts privados. A rota documentada aqui é a rota que deve ser chamada pelo integrador.
Fonte técnica
Seção intitulada “Fonte técnica”Esta documentação reflete o backend Api-Core em produção, build 449, branch production, commit c2313b200d4834b75632da0a9821812491b25411.