Browsers e aplicativos móveis não são um lugar seguro para um secret: qualquer coisa enviada para eles pode ser lida.
Portanto, o front end nunca recebe seu client secret ou uma chave da API. Ele recebe um Connect Token, uma credencial de curta duração que seu backend cria para um usuário e uma conexão.
Emita-o do seu backend, para um usuário autenticado#
- Seu servidor cria uma chave da API com
POST /auth(veja Credenciais). - Seu servidor cria um Connect Token com
POST /connect_tokenAPI, de um endpoint que apenas seus usuários autenticados podem chamar. - O front end recebe o Connect Token e abre Pluggy Connect com ele.
Proteja esse endpoint com sua própria autenticação. Qualquer um que puder chamá-lo pode abrir o Pluggy Connect em seu nome e conectar contas à sua aplicação.
Receita: Emitir Connect Tokens do seu backend.
Detalhes: Autenticação do Pluggy Connect.
O que um Connect Token pode acessar#
- Os Itens criados com esse token, através de
GET /items/{id}API, e uma visão reduzida de suas contas, através deGET /accounts?itemId=. - Nada criado com outro Connect Token.
- Nenhum dado de produto: transações, investimentos, identidade e qualquer outro produto requer uma chave da API. Um Connect Token recebe
403 Forbidden.
Portanto, um Connect Token que vaza expõe no máximo as conexões feitas com ele, e apenas até que expire.
Quanto tempo dura#
Um Connect Token é válido por 30 minutos. Crie um novo para cada conexão em vez de armazená-lo em cache ou compartilhá-lo entre usuários.
Enquanto uma aplicação estiver desativada, seus Connect Tokens também serão rejeitados.
Opções que importam para a segurança#
As opções vão dentro de options no corpo de POST /connect_token; uma propriedade enviada na raiz é ignorada. Veja Configurando um Connect Token.
| Opção | O que fazer |
|---|---|
clientUserId | Defina como um identificador opaco do seu sistema, não um endereço de e-mail ou um CPF. Ele é armazenado no Item e enviado em cada payload de webhook item/*. |
itemId (na raiz) | Escopo o token para um Item existente, para atualizá-lo. Verifique se o Item pertence ao usuário autenticado antes de criar o token. Veja Atualizando um Item. |
webhookUrl | Deve ser uma URL pública HTTPS. Não envia cabeçalhos personalizados, então proteja-o com a assinatura, ou use um webhook criado com POST /webhooks em vez disso. |
oauthRedirectUri | Deve ser HTTPS ou um link profundo para seu aplicativo. Veja Guia de Suporte OAuth. |
No widget, deixe includeSandbox desativado em produção: conectores Sandbox são para testes. Veja Ambientes e Configurações.
Não protege contra#
- Um endpoint que emite Connect Tokens para qualquer um: o token é tão seguro quanto a autenticação à sua frente.
- Atualizar o Item do usuário errado: a API escopo o token para o
itemIdque você passa, mas apenas seu backend sabe qual usuário possui qual Item.
Próximo: Segurança do webhook.
