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:

1. Possuir um deep link (app link) para redirecionar o seu cliente a uma tela de login de seu aplicativo. Essa tela dever ser simples, apresentando apenas botão de login e campo de senha e/ou botão para redirecionar o usuário à loja de Apps;
2. Garantir que o deep link (app link) fornecido inicie por "https" e aceite receber requisições com os parâmetros request_uri e client_id enviados por query string e realize o redirecionamento para a web (https://app-sdb.open.bankly.com.br/hand-off);
3. Enviar ao Bankly, via Forms, esse deep link (app link) juntamente com os dados de sua marca, logo (em formato SVG) e paleta de cores;
4. Disponibilizar dentro do seu aplicativo uma tela de login específica para o fluxo de consentimento (sem derivação para criação de conta).

❗️

Atenção

O deep link (app link) bem como todas as informações citadas acima devem ser enviadas ao Bankly até dia 21/10/24.

📘

Nota

Não é necessário que o parceiro armazene os dados de request_uri e client_id.

Ao cumprir os pré-requisitos mencionados, o seu cliente irá visualizar a tela do aplicativo do parceiro, na qual poderá fazer o login.

Então, dois processos ocorrerão simultaneamente para o usuário:

1. Quando o cliente clicar no botão de login (redirecionado pelo deep link/ app link) e realizar o acesso, o parceiro coletará os dados (request_uri e client_id) recebidos via query string através do deep link (app link) e também o número de documento do usuário (que o próprio sistema do parceiro deverá identificar para permitir o acesso do cliente). Esses dados serão usados para gerar um ticket a ser enviado pelo endpoint Geração do ticket de acesso ao WebView ;
2. Após gerar esse ticket, o parceiro deverá enviar o seu valor para chamar o nosso WebView (https://app-sdb.open.bankly.com.br/).

Uma vez que o cliente está dentro do Webview, nós gerenciaremos a visualização e os aceites. Ao sair, o cliente é redirecionado para para a instituição na qual ele iniciou a jornada.

Tela de login para o fluxo de consentimento

O parceiro também terá de disponibilizar um menu específico para o Open Finance na tela principal de seu aplicativo.

Esse menu deve conter um botão chamado "Meus compartilhamentos". Ao clicar nesse botão, o usuário poderá fazer o aceite, consultar os consentimentos dados e revogá-los se achar necessário.

O acesso à tela de compartilhamento também é feito via WebView do Bankly. Para redirecionar o cliente para o WebView, o parceiro deverá utilizar o endpoint Gestão de consentimentos, e enviar os parâmetros documentNumber e accountNumber.

A requisição retornará o parâmetro ticketId , que dará acesso ao WebView como informado anteriormente.

🚧

Importante

Leia atentamente as instruções contidas no Manual de Layout do Banco Central e o Guia de Experiência do Usuário para a correta construção do menu Open Finance.

Jornada de transmissão de dados por WebView

1. 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;
2. O cliente escolhe realizar o compartilhamento de dados via Open Finance e seleciona o banco do parceiro Bankly para fazer esse compartilhamento (banco B);
3. 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;
4. A instituição receptora de dados (banco A) redireciona o cliente do parceiro para a tela de login do aplicativo do parceiro, por meio do deep link (app link) fornecido previamente pelo parceiro;
5. Após o login no aplicativo do parceiro, o seu backend realizará uma solicitação para criar um ticket. Com o ticket gerado, o backend retornará o ticketId ao aplicativo. Quando o WebView  for aberto no app do parceiro, o ticketId será enviado por query string;
6. Em seguida, a URL disponibilizada pelo Bankly (https://app-sdb.open.bankly.com.br/) 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.);
7. Nessa tela, o cliente do parceiro deve dar o consentimento para o compartilhamento de seus dados;
8. Consentido o compartilhamento ou não, o cliente do parceiro é redirecionado pelo Bankly para a tela da instituição receptora de dados (banco A). E, de forma assíncrona, o Bankly realiza os procedimentos para o compartilhamento dos dados;
9. Em seu ambiente, a instituição receptora de dados (banco A) efetiva a recepção.

🚧

Importante

Quando o evento "EventCloseWebview" for acionado, a aplicação do parceiro deverá reconhecê-lo e fechar o WebView.

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.