Ambientes e Configurações

Obtenha sua aplicação web rapidamente e sem problemas integrada à nossa plataforma usando nosso Connect Widget!

Ambientes#

O Connect Widget funciona em um único ambiente de Produção, disponível em:

https://connect.pluggy.ai

Usando o ambiente de produção, você pode acessar tanto os conectores Live quanto os conectores Sandbox — não há uma URL de sandbox separada.

Testes no Sandbox#

Para fins de teste, você pode experimentar sua integração usando nossos conectores do Pluggy Bank Sandbox. O Pluggy Bank fornece transações atualizadas diariamente e permite que você teste todos os fluxos de login e cenários que você encontraria ao usar qualquer um dos conectores Live disponíveis.

Para exibir conectores Sandbox na etapa de seleção de Conector, defina a propriedade includeSandbox como true (não destinado ao uso em produção):

const pluggyConnect = new PluggyConnect({
  connectToken: 'your-connect-token',
  includeSandbox: true,
  onSuccess: (itemData) => {
    console.log('Success!', itemData);
  },
});

Credenciais de teste do Pluggy Bank#

Para uma conexão bem-sucedida com o conector Pluggy Bank, use:

Qualquer outro nome de usuário resultará em um erro INVALID_CREDENTIALS. Para a lista completa de usuários de teste cobrindo cenários de erro (conta bloqueada, site não disponível, fluxos de MFA, Open Finance e mais), consulte o guia do Sandbox.

SDKs disponíveis#

O Connect Widget está atualmente disponível para os seguintes ambientes:

Navegue até cada projeto para encontrar informações de uso mais detalhadas em cada README. Você também pode conferir nosso repositório de Quickstarts para ajudá-lo a começar com sua própria integração.

Interessado em contribuir?

Deixe-nos saber se você precisa, ou está interessado em contribuir, com uma biblioteca para uma linguagem não representada aqui! Escreva para nós em hello@pluggy.ai

Configurações disponíveis#

Nota: todos os parâmetros são opcionais, exceto pelo connectToken.

onEvent#

Use este callback para lidar com eventos específicos de interação do usuário.

A propriedade event dentro do payload de onEvent é o evento atual acionado. Os eventos disponíveis que podem ser tratados por meio deste método são:

O objeto payload tem uma propriedade timestamp, e alguns eventos incluem dados extras:

• 'SELECTED_INSTITUTION' inclui a propriedade connector, que é o conector selecionado pelo usuário.
• 'LOGIN_SUCCESS', 'LOGIN_MFA_SUCCESS', 'LOGIN_STEP_COMPLETED' e 'ITEM_RESPONSE' incluem a propriedade item, que é os dados do Item relacionados à conexão atual.

Mudança de assinatura v2.0.0

Desde a versão 2.0.0 do widget, onEvent recebe um único objeto de payload: (payload: ConnectEventPayload) => void. Nas versões 1.x, recebia dois argumentos: (event: string, metadata: { timestamp: number }) => void.

Webhooks e callbacks#

Após um usuário fazer uma conexão com o Pluggy Connect Widget, existem duas maneiras de obter o ID do Item recém-criado.

Callbacks do Connect Widget#

No frontend da sua aplicação (site, aplicativo, etc.), quando você está usando o Connect Widget, você tem acesso a callbacks. Dessa forma, você pode passar uma função para o widget que será executada quando um evento acontecer (por exemplo, uma conta conectada com sucesso ou com erro). O que é importante você saber aqui é que os callbacks são usados para melhorar a experiência do usuário, como redirecionar usuários para uma página de sucesso ou mostrar uma mensagem de erro.

<PluggyConnect
  ...
  onSuccess={({ item }) => console.log(item.id)}
  onError={({ message, data: { item } }) => showErrorPage(message)}
/>

Essa abordagem é ótima para lidar com a lógica do frontend, mas é inconsistente por natureza: você não pode contar com ela para sua lógica de negócios ou integridade do banco de dados. Por exemplo, um usuário pode fechar o aplicativo antes que a conexão termine com sucesso, e você nunca perceberá que a conexão foi finalizada. Para ser consistente, use webhooks.

onSuccess não será chamado sempre!

A Caixa Econômica Federal (PF & PJ) possui fluxos de autorização que exigem que o usuário autorize o Pluggy como um dispositivo confiável, e o processo tem um atraso de cerca de 30 minutos. Nesse cenário, você receberá um onError com o status USER_AUTHORIZATION_PENDING, e o evento de SUCESSO será comunicado via webhooks.

Webhooks#

Um webhook (também conhecido como callback web) é um método simples que facilita para um aplicativo ou sistema fornecer informações em tempo real sempre que um evento acontece — ou seja, é uma maneira de receber dados passivamente entre dois sistemas através de um HTTP POST.

Os webhooks enviarão uma notificação para sua API / backend quando eventos relacionados a conexões acontecerem. Por exemplo, você pode ser notificado quando um Item é criado ou atualizado (leia mais na referência de Webhooks).

Você precisará criar um endpoint para ouvir os eventos de webhook do Pluggy e, em seguida, criar um webhook apontando para esse endpoint. Mais detalhes podem ser encontrados na referência de Webhooks, mas o que é importante entender aqui é que os webhooks são a maneira de obter o ID do Item de uma conexão para você trabalhar. Embora você também possa recuperar o ID do Item com callbacks no frontend, lidar com a lógica de negócios com eles é uma má prática: por exemplo, um usuário fechando o site enquanto faz a conexão resultará na perda do ID do Item dessa conexão, significando que você nunca poderá recuperar os dados do Item.

Resumo#