Banco Inter
Bem-vindo à documentação do conector do Banco Inter, que integra as soluções de Pagamentos, Pix e Cobrança para automatizar operações financeiras, como a gestão de boletos e pagamentos. Essa documentação tem como objetivo orientar os desenvolvedores na implementação e integração com as APIs do Banco Inter, garantindo uma experiência completa e unificada.
Para mais informações, o Portal Developers é acessível através do link: https://developers.inter.co/ ou https://developers.inter.co/docs/introducao/nossas-apis diretamente.
O conector do Banco Inter da Fluid API possibilita a integração com três soluções principais:
- Pagamentos: Permite a realização e o acompanhamento de transações de pagamento.
- Pix: Habilita transações instantâneas via Pix, incluindo a geração de QR Codes e a consulta de operações.
- Cobrança: Oferece ferramentas para a criação, gerenciamento e acompanhamento de cobranças.
Com essa integração, os desenvolvedores podem oferecer aos seus clientes uma experiência completa, utilizando as facilidades e a robustez das APIs do Banco Inter.
Todas as APIs utilizam um mecanismo de autenticação baseado em tokens. Para iniciar a integração, siga estes passos:
- Obtenção das Credenciais: Cadastre sua aplicação no portal do Banco Inter para receber o Client ID e o Client Secret.
- Geração do Token: Realize a requisição ao endpoint de autenticação para obter um token de acesso válido, que deverá ser incluído no header de todas as chamadas subsequentes.
- Renovação do Token: Verifique a validade do token e implemente a rotina de renovação conforme especificado na documentação do Banco Inter.
Observação: Consulte a documentação oficial de autenticação para mais detalhes sobre os parâmetros e fluxos.
O que é mTLS?
O TLS mútuo, ou mTLS, é um método para autenticação mútua. O mTLS assegura que as partes em cada extremidade de uma conexão de rede são quem afirmam ser, verificando que ambas têm a chave privada correta. As informações dentro de seus respectivos certificados TLS fornecem a verificação adicional.
O mTLS é frequentemente usado em uma estrutura de segurança Zero Trust* para verificar usuários, dispositivos e servidores dentro de uma organização. Também pode ajudar a manter as APIs seguras.
*Zero Trust significa que nenhum usuário, dispositivo ou tráfego de rede é confiável por padrão, uma abordagem que ajuda a eliminar muitas vulnerabilidades de segurança.
Como o Inter usa o mTLS?
1. Chave pública e privada
A TLS trabalha utilizando uma técnica chamada criptografia de chave pública, que depende de um par de chaves — uma chave pública e uma chave privada.
Qualquer coisa criptografada com a chave pública pode ser descriptografada apenas com a chave privada.
Qualquer coisa criptografada com a chave privada pode ser descriptografada apenas com a chave pública.
Portanto, um servidor que descriptografa uma mensagem que foi criptografada com a chave pública prova que possui a chave privada. Qualquer pessoa pode visualizar a chave pública verificando o certificado TLS do domínio ou do servidor.
2. Certificado TLS
Um certificado TLS é um arquivo de dados que contém informações importantes para verificar a identidade de um servidor ou dispositivo, incluindo a chave pública, uma declaração de quem emitiu o certificado (os certificados TLS são emitidos por uma autoridade de certificação) e a data de expiração do certificado.
3. Handshake TLS
O handshake TLS é o processo de verificação do certificado TLS e da posse da chave privada pelo servidor. O handshake TLS também estabelece como a criptografia ocorrerá quando o handshake estiver concluído
OBS: Acesse aqui nosso passo a passo criar uma conexão.
Estes são os seguintes parâmetros de configuração da conexão Banco Inter que serão requisitados em sua criação:
- Nome: Identificador da conexão para facilitar sua organização.
- Descrição: Campo opcional para detalhar o propósito da conexão e sua utilização dentro do seu fluxo de integração.
- ID do Cliente: Informe o client_id da aplicação registrada no Banco Inter.
- Chave Secreta do Cliente: Informe o client_secret da aplicação.
- Certificado Público: Chave pública necessária para autenticação segura com a API do Banco Inter.
- Certificado Privado: Chave privada utilizada para assinar as requisições enviadas à API do Banco Inter.
- Escopo: Defina os perfis de acesso da conexão, conforme a necessidade da sua aplicação.
- Ambiente: Escolha entre os ambientes Sandbox (teste) ou Produção.
- URL do Ambiente: Informe a URL da API do Banco Inter correspondente ao ambiente escolhido.
Para utilizar o conector, é necessário configurar os seguintes recursos e operações:
- Boletos:
- Operações para emissão, consulta e listagem de boletos.
- Pagamentos:
- Operações para busca e inclusão de pagamentos utilizando códigos de barras ou linha digitável.
- Listar Boletos:
- Descrição: Lista boletos cadastrados na conta especificada.
- Parâmetros Requeridos:
- accountId: Identificador da conta (obtido via API /v1/accounts).
- bankSlipId: Identificador único do boleto.
- Parâmetros Opcionais:
- offset: Número de itens a ignorar antes de formar a resposta.
- limit: Número máximo de itens a retornar.
- Buscar Pagamentos:
- Descrição: Busca pagamentos realizados em um período específico.
- Parâmetros Requeridos:
- dataInicio: Data de início da pesquisa (formato: yyyy-mm-dd).
- dataFim: Data de fim da pesquisa (formato: yyyy-mm-dd).
- Incluir Pagamento com Código de Barras:
- Descrição: Realiza o pagamento de um título utilizando código de barras ou linha digitável.
- Parâmetros Requeridos:
- codBarraLinhaDigitavel: Código de barras ou linha digitável.
- valorPagar: Valor a ser pago.
- dataVencimento: Data de vencimento do título (formato: yyyy-mm-dd).
- Parâmetros Opcionais:
- dataPagamento: Data para efetivação do pagamento (se não informado, será feito no mesmo dia; formato: yyyy-mm-dd).
- Formato de Datas: Certifique-se de utilizar o formato yyyy-mm-dd para campos de data.
- Autenticação: A configuração das credenciais da API do Banco Inter é essencial para a comunicação com os endpoints.
- Limites de Paginação: Utilize os parâmetros offset e limit para gerenciar grandes volumes de dados retornados.
O conector Banco Inter oferece uma interface prática e segura para gerenciar operações financeiras, possibilitando maior automação e eficiência em processos críticos. Com recursos como emissão e pagamento de boletos, é uma ferramenta essencial para integrações financeiras modernas.
