Secure Widget

Por definição, um widget é um elemento de interação que fornece uma funcionalidade específica a determinado usuário.

O Secure Widget é uma forma prática para permitir que o cliente faça a coleta das credenciais de seu usuário final de maneira segura, certificando-se que esses dados serão armazenadas somente no Open Vault da Celcoin.

📘

Garantia de Privacidade

O Secure Widget é uma forma segura de obter as credenciais dos usuários finais sem a necessidade de o cliente interagir ou armazenar os dados temporariamente em seu ambiente. Toda a comunicação será feita diretamente entre a CELCOIN e o usuário final, garantindo que os dados sejam encriptados e protegidos no Open Vault tão logo tenham sido coletados.

Interface do Secure WidgetInterface do Secure Widget

Interface do Secure Widget

Como funciona o Secure Widget?

Através de uma chamada em nossa API de OpenBanking, é gerada uma URL por onde o Widget poderá ser acessado. Para maior segurança, todas as URLs geradas tem um prazo de validade de dez minutos, evitando assim que alguém possa utilizar sua URL para benefício próprio.

  • A URL gerada pode ser acessada tanto por celulares quanto por computadores, e já vem seu próprio hash de configuração, que contém todas as informações necessárias e customizadas para uso. O hash nunca se repete nas chamadas, sendo sempre gerado um novo para cada utilização do Widget, além de ser encriptado para proteger suas configurações.
  • O Secure Widget pode ser configurado de maneira extensível, permitindo que o cliente decida quais conectores estarão disponíveis para integração com o usuário final. Tudo pode ser alterado a qualquer momento através de nossos endpoints de configuração existentes na API.
  • Após finalizada a criação do consentimento, o usuário será redirecionado para uma página escolhida ao gerar a URL do Widget, enviando os dados de controle do consentimento através dessa URL de callback.

Fluxo

Fluxo de configuração e uso do Secure WidgetFluxo de configuração e uso do Secure Widget

Fluxo de configuração e uso do Secure Widget

Para poder acessar o Widget, é necessário fazer realizar algumas configurações para que possamos preparar o ambiente para que os usuários finais possam acessá-lo de maneira segura. As configurações são feitas para ajustar dados que serão utilizados para a construção visual e funcional do produto.

É necessário configurar algumas informações, conforme segue:

  • Termos de Uso e Aviso de Privacidade
    A configuração desses textos pode ser feita através do endpoint /securewidget/legaltexts, onde serão enviadas as URLs dos textos. Os textos devem estar em formato PDF para melhor exibição.
  • Logo da empresa
    O logo poderá ser configurado através do endpoint /securewidget/logo. A URL do logo deverá ser enviada juntamente com o nome da empresa. Caso haja alguma falha na exibição do logo, o texto enviado será utilizado.
  • Conectores que serão disponibilizados e sua ordem de exibição
    É possível configurar quais conectores ficaram disponíveis para seu usuário, além de alterar a ordem em que devem aparecer. A configuração é feita no endpoint /securewidget/partner, enviando uma lista com o id de cada conector.
    Caso os conectores não sejam configurados, todos os conectores serão exibidos em ordem alfabética.

Após realizar a configuração do Widget, o ambiente já estará pronto para ser acessado. Para receber a URL de acesso é necessário realizar uma chamada HTTP POST para o endpoint /securewidget/token.

O redirecionamento será feito após a confirmação de sucesso na criação do consentimento, onde serão passadas algumas informações através da URL de callback. Essas informações não são sensíveis e servirão para o controle do consentimento. Caso necessário, essas informações também podem ser consultas através do endpoint HTTP GET /consent.

A documentação dos endpoints encontra-se mais a frente, especificando os detalhes sobre cada chamada.

Conectores

A exibição dos conectores é feita de maneira dinâmica, e ainda é possível configurar quais conectores estarão disponíveis ao usuário, além de ser possível definir a ordem em que eles serão exibidos. A ordem de exibição segue a ordem de inclusão do conector durante a chamada do endpoint /securewidget/partner.

Caso o usuário queira utilizar um conector que não está disponível, é possível fazer uma sugestão para um novo conector. Para isso, é necessário fazer uma busca com o nome do conector desejado, para que então apareça a tela de sugestão.

Tela de sugestão de novos conectoresTela de sugestão de novos conectores

Tela de sugestão de novos conectores

Customização

Os seguintes itens podem ser customizados através da API:

  • Logo;
  • Ordem e disponibilidade dos conectores;
  • Documentos sobre Termos de Uso e Aviso de Privacidade.