API de integração
Leia fornecedores, contratos, documentos de faturamento, contas a pagar, pagamentos e dados bancários do Afflux a partir do seu ERP ou de outro sistema.
Em resumo
- A API deixa o ERP da sua empresa — ou qualquer sistema que fale HTTP — ler o que o Afflux organiza, sem conector feito sob medida.
- É REST, em JSON, autenticada por uma chave por integração e versionada em
/v1. - A sincronização é incremental: o sistema pergunta "o que mudou desde a última vez?" e recebe só isso, página a página.
- Nesta versão a API só lê. A baixa de pagamento vinda do ERP está nos próximos passos.
Endereço e especificação
| Endereço base | https://app.afflux.com.br/api/v1 |
| Especificação OpenAPI 3.1 | /api/v1/openapi.json — pública, sem chave |
| Formato | JSON (application/json); erros em application/problem+json |
| Autenticação | Authorization: Bearer afx_live_… |
A especificação é gerada a partir do mesmo código que monta as respostas — é a fonte da verdade para tipos, campos e parâmetros. Importe-a no Postman, no Insomnia ou num gerador de cliente da sua linguagem.
O que dá para ler
| Recurso | Para quê | Permissão da integração |
|---|---|---|
GET /integracao | Conferir a chave, a organização e os limites | qualquer chave válida |
GET /fornecedores | Cadastro dos prestadores (CNPJ/CPF, endereço, situação, código) | fornecedor.ler |
GET /fornecedores/{id}/contas-bancarias | Dados bancários para a remessa | contabancaria.ler |
GET /contratos | Vigência, valor, regime, reajuste, centro de custo | contrato.ler |
GET /documentos-faturamento | NFs, RPAs e recibos, com retenções e o arquivo | faturamento.ler |
GET /contas-pagar | Títulos a pagar, com a situação de pagamento | financeiro.ler |
GET /pagamentos | Pagamentos registrados no Afflux | financeiro.ler |
Cada recurso tem também o detalhe por id (/fornecedores/{id}, /contratos/{id} …). A lista completa, com cada campo, está em Recursos.
Como a integração enxerga a sua empresa
- Uma organização por chave. A chave pertence a uma integração, e a integração a uma organização. Não existe parâmetro para escolher a organização — ela vem da chave.
- Só o que foi concedido. Quem cria a integração escolhe as permissões; chamar um recurso sem a permissão responde
403. - Registro de outra organização não existe. Pedir por id algo que não é da organização da chave responde
404, igual a um id inventado.