Integração por API (ERP)
Deixe o ERP ou outro sistema da sua empresa ler os dados do Afflux, com uma chave por integração, sob controle de quem administra.
Em resumo
- Uma integração é um sistema da sua empresa — o ERP, por exemplo — que lê fornecedores, contratos, documentos de faturamento, contas a pagar e pagamentos do Afflux.
- Você escolhe o que cada integração pode ler e entrega a ela uma chave. A chave aparece uma única vez.
- Revogar uma chave vale na hora, e quem administra recebe um e-mail a cada chave gerada ou revogada.
- A API está em todos os planos; o que muda é quantas integrações e quantas requisições por dia. Ver exige Ver as integrações por API, as chaves e o consumo; criar, gerar e revogar exige Criar integrações por API, gerar e revogar chaves.
Onde fica
ConfiguraçõesIntegrações, no cartão API do Afflux. Ali aparecem:
- quantas integrações o plano permite e quantas estão ativas;
- quantas requisições a sua empresa fez hoje, e o limite do dia;
- a lista de integrações, com a situação e o último uso de cada uma.
Quem vai desenvolver a integração do lado da sua empresa encontra tudo na documentação da API.
Criar uma integração
Comece
No cartão API do Afflux, clique em Nova integração. Se o botão não aparece, o plano não inclui a API ou o limite de integrações ativas já foi atingido.
Preencha
- Nomeobrigatório
- Como a equipe reconhece o sistema, por exemplo: ERP Protheus — financeiro.
- Descrição
- Quem mantém a integração do lado da sua empresa e para que ela serve.
- O que a integração pode lerobrigatório
- Marque só o que o sistema precisa. Você só consegue conceder o que o seu próprio papel tem.
Dados bancários pedem cuidado
Com Ver dados bancarios, o sistema de fora recebe agência, conta e chave PIX dos fornecedores. Cada leitura fica registrada na tela da integração.
Clique em Criar integração.
Gere a chave
Na tela da integração, escolha a validade (sem validade, 90 dias, 180 dias ou 1 ano) e clique em Gerar chave. A chave aparece uma única vez: copie e entregue a quem mantém o sistema por um canal seguro. O Afflux guarda só um resumo dela e não consegue mostrá-la de novo.
Acompanhar
A tela de cada integração mostra:
Quando cada uma foi gerada, quando expira, o último uso e se está válida, expirada ou revogada.
Requisições por tipo de dado, quantas foram recusadas e quantas falharam do lado do Afflux.
Cada conta lida, de qual fornecedor e quando — os 50 mais recentes.
Trocar, revogar e desativar
- Trocar a chave sem parar o sistema: gere uma segunda chave, atualize o sistema e revogue a antiga. Cada integração tem no máximo duas chaves válidas.
- Revogar: Revogar na chave. Vale na hora: o sistema que a usa passa a ser recusado na próxima consulta. Não há como desfazer.
- Desativar a integração: Desativar integração no fim da tela. Revoga todas as chaves dela. Não há como reativar; para voltar, crie outra integração.
Revogar e desativar funcionam mesmo com a organização suspensa — cortar um acesso nunca fica bloqueado.
Plano e limites
| Plano | Integrações ativas | Requisições por dia |
|---|---|---|
| Starter | 1 | 2.000 |
| Growth | 1 | 5.000 |
| Pro | 2 | 10.000 |
| Limites maiores | Sob consulta | Sob consulta |
| Situação | O que acontece |
|---|---|
| A assinatura ainda não tem os limites da API | O cartão avisa, e nenhuma integração funciona — as já criadas continuam cadastradas. Acontece com assinatura registrada antes da API: peça à equipe do Afflux que a atualize |
| Mais integrações ativas do que o plano permite | Funcionam as mais antigas; as demais aparecem como Fora do plano até você desativar alguma |
| A cota diária de requisições acabou | Os sistemas são recusados até a meia-noite; o Afflux continua funcionando normalmente para as pessoas |
| Liberação piloto | O cartão mostra até quando ela vale; depois disso valem os limites do plano |
Mudar de plano é conversa com a equipe do Afflux — veja Plano e assinatura.
Avisos por e-mail
Quem tem Criar integrações por API, gerar e revogar chaves recebe um e-mail quando alguém gera ou revoga uma chave — menos quem fez. Uma chave que ninguém reconhece é motivo para revogar na hora. Os avisos podem ser ajustados em Notificações, no grupo Integrações por API.