Pular para o conteúdo principal

Comunicação

A aba Comunicação reúne os parâmetros de integração com o banco via API, que permitem importar o extrato bancário de forma automática, sem depender de arquivo. A integração via API troca informações diretamente com a instituição financeira, trazendo mais agilidade ao processo. É a quarta aba do formulário da Configuração de Extrato e seus campos ficam disponíveis quando o banco e o layout selecionados oferecem essa tecnologia.

Dica

As credenciais de acesso à API (como Client Id, Client Secret e tokens) são informações sensíveis. Guarde-as com segurança e não as compartilhe.

Visão geral da aba​

Aba Comunicação da configuração de extrato, com o bloco Configuração API Banco: Versão da API, Tipo de ambiente, Client Id, Client Secret, URL Token API, URL API e Token.

Figura 1: Comunicação, Visão geral da aba.

A aba apresenta os dados de conexão com a API do banco. Os campos exibidos variam conforme a instituição financeira, pois cada banco define seus próprios requisitos de autenticação e endpoints. De modo geral, a configuração contempla as credenciais de acesso e os parâmetros necessários para o Add-On consultar e importar o extrato automaticamente.

Campos da aba​

  • Versão da API: versão da API do banco utilizada na integração. Tipo: seletor.
  • Tipo de ambiente: ambiente usado na comunicação (por exemplo produção ou homologação). Tipo: seletor.
  • Client Id: identificador do cliente fornecido pelo banco para acesso à API (credencial). Tipo: texto.
  • Client Secret: chave secreta do cliente fornecida pelo banco (credencial). Tipo: texto.
  • URL Token API: endereço (endpoint) usado para autenticar e obter o token de acesso. Tipo: texto.
  • URL API: endereço (endpoint) da API de extratos do banco. Tipo: texto.
  • Token: token de acesso gerado para a integração. Tipo: texto.

Configuração por banco​

A integração via API está disponível para os bancos que oferecem essa tecnologia. As configurações específicas (credenciais, ambiente e demais parâmetros) seguem a documentação de cada instituição, entre elas: Banco do Brasil, Banco Santander, Banco Rendimento, Banco Bradesco e Banco Fitbank.

Após configurar a comunicação, habilite o processamento automático na aba Dados Gerais (parâmetros Automatizar processamento e, quando aplicável, a integração via API) para que o extrato seja importado e processado pelo Serviço sem intervenção manual.

Conclusão​

A aba Comunicação habilita a importação automática do extrato direto do banco, eliminando a etapa de obter e importar o arquivo manualmente. Combinada com a automação do processamento e da conciliação, ela permite que todo o ciclo da Conciliação Financeira ocorra de ponta a ponta.

Artigos relacionados​