Pré-requisitos
Para testar as APIs de open banking, é necessário a obtenção de dois registros de usuários distintos, além de incluir APPs de teste:
- Registro no Portal do Desenvolvedor: Saiba mais em Onboarding do desenvolvedor
- Registro no Banco de Homologação
- Criar/Gerenciar os App's: AQUI
- Postman v7.36 ou superior
Registro no Portal do Desenvolvedor
- Cadastre-se no portal do desenvolvedor como uma Instituição Parceira, verifique seu e-mail e realize o login.
- Assim que estiver logado, crie aplicativos no botão ‘Criar’ e selecione a modalidade do aplicativo (informações de conta – AISP, iniciação de pagamentos – PISP)
- Para criação do App, é necessário o fornecimento do client-id, client-secret e client-certificate
- Nota: É necessário fornecer o url de redirecionamento do Postman, isso pode ser feito durante o registro do novo aplicativo, ou, editando o aplicativo que já foi criado, e atualizando o campo ‘URL de redirecionamento’ e pressionando TAB para registrar a URL.
Registro no portal do Banco de Homologação
- Registre-se no Banco de Homologação e faça o login com os dados de usuário.
- Uma vez logado, você pode clicar no botão ‘simular’ para inicializar as contas. Essas contas serão usadas para o teste de aplicativos de Informações de Contas (AISP) e Inciação de Pagamentos (PISP)
Configuração do Postman
-
Baixe e importe os arquivos abaixo para o Postman
- Selecione o ambiente que foi baixado
- Atualize as variáveis (como demonstrado abaixo) de acordo com o registro de seu aplicativo (no portal do desenvolvedor)
- Altere os valores dos campos
client_id
eclient_secret
para a API PSIC/AISP - Altere os valores dos campos
pisp_client_id
episp_client_secret
para a API PSIP/PISP - Altere os demais valores de
x-idempotency-key
,x-fapi-financial-id
para as chamadas as APIs
- Altere (se necessário), as URLs (authorization, oauth2tokenurl) de acordo com a autenticação no portal do desenvolvedor.
Executar scripts do Postman
- Observação: é necessário calcular o objeto de solicitação jwt, o que não pode ser realizado diretamente no Postman, portanto, instalaremos uma biblioteca para tal.
Fluxo do Serviço de Informações de Conta (SIC/AISP)
-
Para o Serviço de Informações de Conta, com o mesmo consentimento, podemos acessar todas as APIs relacionadas a contas.
- Execute a requisição
Generate Access Token
- Abra a requisição
Create Account Consent
, altere as datas e execute a requisição - Para utilização de mais APIs, teremos que realizar o fluxo de autorização do Usuário (PSU/cliente do Banco de Homologação)
- Abra a requisição
Get Accounts
, clique na aba Authorization e selecione o typeOAUTH 2.0
, informe os dados conforme a imagem abaixo e em seguida clique emGet New Access Token
- Gerar Token de Acesso
- Modificar datas e solicitar autorização para criação de conta
- Para utilização de mais APIs, teremos que realizar o fluxo de autorização do Usuário (cliente do Banco de Homologação)
- Em Get Accounts API, siga para a guia de Autorização e selecione OAUTH 2.0 como tipo de autorização e em seguida, clique em obter novo token de acesso, como abaixo:
- Execute a requisição
- Este passo irá abrir a tela de login do Banco de Homologação no Postman. Preencha os campos, selecione Contas e clique em Confirmar
- Voltando ao ambiente do Postman, clique em
Use Token
.
- Agora você tem acesso às APIs de Contas e todos endpoints dependentes
- Caso tenha criado diversos tokens, selecione o último no menu drop-down em tokens disponíveis
Fluxo PSIP
- Fluxo de Iniciação de Pagamentos é o mesmo que o de Informações de Conta, com a diferença de que você precisará alterar os detalhes na guia Autorização (Client ID, Client Secret, Scope):
-
A autorização do usuário é necessária para todas chamadas POST na API de Iniciação de Pagamentos, portanto é necessário realizar o fluxo de obtenção de um novo token para as seguintes APIs:
- /domestic-payments
- /domestic-scheduled-payments
- /domestic-standing-orders