Transmissão de dados por WebView
A jornada de transmissão via WebView permite o compartilhamento de dados do cliente sem que o parceiro precise se integrar via API.
Pré-requisitos
Para que a jornada de transmissão de dados ocorra com sucesso, o parceiro deve:
- Receber do Bankly a URL de acesso à jornada via WebView: https://app.open.bankly.com.br;
- Enviar ao Bankly a paleta de cores da marca e uma URL contendo o logotipo em formato SVG;
- Consultar o ticket para abertura do WebView, informando os parâmetros
request_uri
,client_id
edocument_number
no endpoint de consulta específico (em construção). Exemplo de ticket:ticketId
: "1aafd0fd-840a-401f-a7ca-1c9a756f9d34". - Incluir o ticket como parâmetro na
query string
na URL ao abrir o WebView: https://app.open.bankly.com.br/?ticket=${ticket} - Fornecer ao Bankly um app link que receberá dois parâmetros via
querystring
:request_uri
eclient_id
para redirecionar a instituição receptora de dados para a tela de login do parceiro. O app link fornecido deverá redirecionar o usuário para a loja de aplicativos, para possibilitar a instalação do app no dispositivo do cliente, caso ele não esteja instalado; - Disponibilizar uma tela de login específico para o fluxo de consentimento (sem derivação para criação de conta ou mudança de senha).
Jornada de transmissão de dados por WebView
- O cliente de nosso parceiro inicia a jornada na instituição com a qual deseja compartilhar os dados (banco A). Essa instituição deve estar apta a atuar como instituição receptora de dados no ecossistema Open Finance;
- O cliente escolhe realizar o compartilhamento de dados via Open Finance e seleciona o banco do parceiro Bankly para fazer esse compartilhamento (banco B);
- Então, a instituição receptora de dados (banco A) envia uma requisição ao Bankly (instituição transmissora de dados), contendo os termos de consentimento com os quais o cliente do parceiro deverá concordar;
- O Bankly redireciona o cliente do parceiro para a tela de login do aplicativo do parceiro, por meio do app link fornecido previamente pelo parceiro;
- Após o cliente fazer login no aplicativo do parceiro, o backend realizará uma solicitação para criar um ticket. Com o ticket gerado, o backend retornará o ticket ID ao aplicativo. Quando o WebView for aberto no app do parceiro, o ticket ID será enviado por
querystring
; - Em seguida, a URL disponibilizada pelo Bankly realiza por WebView a abertura de uma tela que possui todos os detalhes dos termos de consentimento (como o nome da instituição receptora de dados, quais são os dados compartilhados, o período de compartilhamento, a conta que originará o compartilhamento de dados etc.);
- Nessa tela, o cliente do parceiro deve dar o consentimento para o compartilhamento de seus dados;
- Após o consentimento, o cliente do parceiro é redirecionado pelo Bankly para a tela da receptora de dados (banco A). E, de forma assíncrona, o Bankly realiza os procedimentos para o compartilhamento dos dados;
- Em seu ambiente, a instituição receptora de dados (banco A) efetiva a recepção;
- O parceiro tem a opção de fechar a WebView. Esse fechamento será feito pela aplicação do parceiro, que deve ter a capacidade de ler um evento disparado com o nome: “EventCloseWebview”. Vale ressaltar que esse evento só será disparado quando o fluxo terminar.
Exemplos
Veja a seguir exemplos das telas na jornada por WebView:
Redirecionamento para a instituição transmissora de dados
Confirmação dos dados
Nota
Recordamos que, após fornecer o consentimento referente ao compartilhamento de seus dados, o cliente de nosso parceiro poderá revogá-lo a qualquer momento.
Updated 7 days ago