Criando um Item

Como criar sua primeira conexão regulamentada de Open Finance, passo a passo pelo Connect Widget da Pluggy ou através da API.

Como criar sua primeira conexão Regulada de Open Finance, passo a passo através do Connect Widget da Pluggy ou através da API.

Conectando um Item com Open Finance através do Pluggy Connect#

Quando um usuário se conecta através do Open Finance, o processo de login é diferente de um Direct Connector.

Primeiro, o usuário é solicitado a informar seu CPF (para conectores pessoais) ou CNPJ.

Em seguida, o usuário é levado à página de login do Open Finance da instituição (com um pop-up) para completar o processo de login.

Esta etapa depende da instituição: pode solicitar que o usuário escaneie um QR, ou oferecer um link que abre o aplicativo da instituição diretamente, pedir credenciais, etc.

Após o login, o usuário é solicitado a selecionar as informações que compartilhará.

Depois que o usuário aceita compartilhar essas informações, o pop-up é fechado e ele é levado de volta à tela de conexão, enquanto o conector termina de recuperar os dados.

Esse fluxo é resolvido de forma padrão no Pluggy Connect. Se você não estiver usando o Pluggy Connect, consulte o guia no final desta página.

Conectando um Item com Open Finance através da API#

Use esta abordagem se você não usar o Pluggy Connect e quiser se conectar usando a API da Pluggy. Uma vez que o recurso de Open Finance esteja habilitado para seu plano, siga estas etapas:

  1. Obtenha o ID do conector para o Conector de Open Finance de sua escolha. No endpoint /connectors você verá eles começando com ID 600 e superiores. Por exemplo, o Conector de Open Finance do Itau tem ID 601.
  2. Crie um Item para o ID desse conector. Ele exigirá CPF ou CNPJ dependendo se é um conector Pessoal ou Empresarial.
  3. Siga a documentação do Pluggy OAuth v2 para completar o login. Com esse fluxo, a partir do Item criado você obterá uma URL para abrir para o usuário, que o transferirá para o login da instituição. Nota: O usuário terá alguns minutos para abrir a URL antes que ela expire. Depois, ele terá 20' para passar pelo fluxo completo na página da instituição.
  4. Uma vez que o usuário complete o login, ele é redirecionado para um endpoint de callback do Pluggy OAuth que inicia a conexão no Item automaticamente.
  5. Recupere os dados do Item.

O link de consentimento é de uso único

O link para acessar o banco e completar o fluxo de consentimento é um link de uso único. Ao enviar este link através de aplicativos de mensagens (Slack, WhatsApp, Google Meet, etc.), o aplicativo de mensagens visita primeiro o link e, portanto, pode invalidá-lo antes que o usuário o acesse. Certifique-se de que este link chegue ao usuário sem essas interações acontecendo primeiro, ou então ele mostrará uma tela de erro.

Conta de Teste de Open Finance#

Para se conectar usando nossa conexão de sandbox, veja Fluxo de Open Finance no Sandbox.