Pré-requisitos para integração

Integrar com as APIs de uma empresa pode parecer uma tarefa complicada, mas, com as informações corretas, é possível realizá-la de maneira simples e eficiente.

Confira a seguir os passos necessários para que o parceiro possa realizar a integração com as APIs do Bankly.

1. Obtenha sua credencial

Após fechamento do contrato com a empresa e a realização da agenda de kickoff com o time de Implantação, o parceiro Bankly receberá uma credencial para ter acesso às APIs. Essa credencial é única e pessoal, sendo responsabilidade do parceiro mantê-la segura e protegida em um cofre de chaves.

2. Faça o download de um programa que permita realizar requisições às APIs

Para testar as APIs desejadas, o parceiro deverá baixar um programa específico, como o Postman ou o Insomnia, para rodar a API Hash e fazer requisições.

📘

Nota

Para entender melhor sobre o ambiente e a URL utilizada para a realização dos testes, visite a página Ambiente de Sandbox X Produção.

3. Autenticação MTLS

Siga as instruções necessárias descritas na seção Autenticação e autorização (mTLS / DCR) para configurar o tráfego do certificado mTLS disponibilizado pelo Bankly em suas requisições. Essa configuração irá garantir a segurança e a integridade dos dados trafegados entre as partes envolvidas.

Utilize a credencial obtida anteriormente (Passo 1) para realizar a configuração.

4. Realize a integração com o produto Bankly desejado

Com a autenticação MTLS realizada com sucesso, o parceiro poderá consultar a seção específica deste manual que descreve o produto ao qual deseja se integrar. Em cada seção, estarão disponíveis todas as informações necessárias para utilizar as APIs da empresa de maneira correta.

APIs de cash-out (Pix e TED)

Todas as APIs do Bankly podem ser iniciadas e operadas somente com a credencial obtida no fechamento do contrato, exceto as de cash-out (Pix, TED e Pagamento de contas).

No caso dos produtos de Pix e TED, após criar uma conta utilizando a credencial, é necessário que o parceiro acione o time de Implantação por meio do canal oficial do Slack, criado após o kickoff, para que seja adicionado saldo na conta criada.

👍

Dica

Recomendamos que o parceiro solicite a adição de saldo para somente uma conta e, a partir dela, realize os testes desejados.

Exemplo: Para que o parceiro x possa realizar o cash-out Pix utilizando as contas de teste criadas, pelo menos uma conta precisará possuir saldo. Neste caso, o parceiro deverá informar o número da primeira conta criada ao time de Implantação no canal do Slack, para a adição de saldo.