Consumir APIs

Consumir as APIs Open Banking

4.1 - Documentação dos métodos

 A documentação das APIs Open Banking estão disponbilizadas pelo swagger através do link https://dev.pinbank.com.br/services

 A documentação esta dividida da seguinte forma:

• CashIn = Métodos de entrada de dinheiro na conta digital.
• CashOut = Métodos de saída de dinheiro na conta digital.
• ContaDigital = Métodos relacionados a conta digital.
• Transacoes = Métodos relacionados as transações ecommerce.
• TokenOAuth2 = Métodos do token OAuth2.

4.2 - Propriedades Request / Response

 Todos os métodos possuem uma documentação da request e do response dos endpoints, onde é possivel obter um exemplo JSON ou a descrição do model, este, com a obrigatoriedade de cada propriedade, assim como, tamanho, tipo e valor default.

Exemplo documentação REQUEST


4.3 - Criptografia Request / Response

 Todas as requests devem ser enviadas criptografadas em AES, seguindo as especificações descritas abaixo. O response será retornado criptografado, onde será possivel abrir utilizando os mesmos parametros utilizados no momento da criptografia da request.

• AES = AES 128
• Key = Byte[ ] da chave de criptografia. Campo KeyValue recebido na credencial
• IV = Byte[ ] zerado (16 posições)

Exemplo request com JSON aberto


Exemplo request com JSON criptografado


4.4 - Consumir API

 Todos os métodos devem ser chamados com a palavra Encrypted ao final do metodo. Exemplo: ../api/ContaDigital/SaldoEncrypted

Exemplo POSTMAN com JSON criptografado