Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs

Uso pessoal: leia seus próprios dados com Meu Pluggy

Passo a passo para indivíduos: conecte seus bancos no Meu Pluggy, adicione o conector MeuPluggy no Dashboard da Pluggy e leia suas próprias contas através da Referência da API — grátis, sem due diligence.

Ver como Markdown

Se você é uma pessoa que deseja ler suas próprias contas bancárias com código — um script de finanças pessoais, uma planilha, um aplicativo que só você usa — o caminho é Meu Pluggy mais o conector MeuPluggy. É gratuito, não precisa de diligência prévia e não expira com o teste. É apenas para uso pessoal (até 5 conexões, sem uso comercial).

Empresas que estão construindo um produto para seus usuários seguem a integração regular em vez disso (Início Rápido) e falam com Vendas.

O guia oficial do Meu Pluggy está em meu.pluggy.ai/api-guide. Esta página mostra os mesmos quatro passos com as telas do Dashboard do Pluggy.

Passo 1 — Conecte seus bancos no Meu Pluggy#

Inscreva-se em meu.pluggy.ai e conecte seus bancos lá. É aqui que cada banco é autorizado (CPF, o aplicativo do banco, aprovação). Cada banco é autorizado separadamente, e um banco que você adicionar depois precisa de sua própria autorização.

Passo 2 — Adicione o conector MeuPluggy no Dashboard#

  1. Faça login no Dashboard do Pluggy com a mesma conta que você usa no Meu Pluggy.
  2. Se você usar uma seleção de conector personalizada, certifique-se de que MeuPluggy esteja ativado: Customização → Conectores, pesquise MeuPluggy e abra a aba Direct Connectors do grupo Pessoal (como).
  3. Abra Aplicações → seu aplicativo → Demo e clique em Conectar Conta.
  4. No widget, escolha MeuPluggy — não seu banco, e não o Sandbox — e faça login com sua conta do Meu Pluggy.

Cada banco que você conectou no Meu Pluggy se torna um item nesta aplicação. Esses itens refletem a conexão do Meu Pluggy: eles refletem cada atualização automaticamente (Meu Pluggy atualiza a cada 24 horas), não podem ser atualizados manualmente e enviam webhooks como qualquer item.

O erro mais comum

Se o Dashboard pedir seu CPF e uma aprovação bancária novamente, você escolheu o conector próprio do banco em vez de MeuPluggy. Volte e escolha MeuPluggy.

Passo 3 — Copie o itemId e suas credenciais#

  • itemId: na mesma página Demo, clique no item em Itens Conectados e copie seu id (como). Guarde-o — GET /v2/items não está disponível para contas do Meu Pluggy.
  • Client ID / Client Secret: o Client ID está em Aplicações, na linha do seu aplicativo. O Client Secret é mostrado apenas uma vez, quando é gerado — se você não o armazenou, gere um novo na página do aplicativo (como).

Passo 4 — Leia seus dados#

bash
# 1. Troque suas credenciais por uma chave de API
curl -X POST https://api.pluggy.ai/auth \
  -H "Content-Type: application/json" \
  -d '{"clientId": "<client id>", "clientSecret": "<client secret>"}'
# → { "apiKey": "..." }
 
# 2. Liste as contas de uma conexão
curl "https://api.pluggy.ai/accounts?itemId=<item id>" \
  -H "X-API-KEY: <api key>"
 
# 3. Transações de uma conta (seu id vem do passo 2)
curl "https://api.pluggy.ai/transactions?accountId=<account id>" \
  -H "X-API-KEY: <api key>"

Os SDKs (Node, Python e mais) fazem as mesmas chamadas.

A autorização expira após um ano#

Quando você faz login no Meu Pluggy no Passo 2, você autoriza seu aplicativo a ler as conexões que você tem lá. Essa autorização é o que os itens MeuPluggy leem, e dura um ano a partir do momento em que você a concede. Cada conexão bancária dentro do Meu Pluggy mantém seu próprio consentimento com o banco; esta é separada e fica acima delas.

Você pode ver quando termina no próprio item: GET /items/{id}API retorna isso como consentExpiresAt.

O que acontece quando expira#

  • As leituras param. Contas, transações e as outras listas desse item voltam vazias.
  • A próxima atualização falha com um erro de login. O item muda para LOGIN_ERROR com o código USER_AUTHORIZATION_EXPIRED, e o webhook item/error é acionado. Se você escuta webhooks, esse é seu sinal.

Até que essa próxima atualização ocorra, o item ainda pode mostrar seu último status — UPDATED, sem erro — enquanto as leituras voltam vazias. Verifique consentExpiresAt: uma leitura vazia com uma data passada significa que a autorização expirou, não que suas conexões bancárias pararam de sincronizar.

Como renová-la#

Repita o Passo 2: abra Aplicações → seu aplicativo → Demo, clique em Conectar Conta, escolha MeuPluggy e faça login com sua conta do Meu Pluggy. Conceder isso inicia um novo período de um ano.

Uma atualização acionada pela API ou pela sincronização automática não pode renová-la, porque ninguém está lá para fazer login: termina em USER_AUTHORIZATION_EXPIRED, como acima.

Não assuma o mesmo itemId

Após autorizar novamente, verifique em qual item seus dados estão antes de continuar lendo. Se você armazenar transações do seu lado, reconcilie-as por seus próprios ids em vez de assumir que o item manteve seu id.

Excluir sua conta do Meu Pluggy encerra a autorização imediatamente.

Testando sem dados reais#

Para tentar o fluxo sem suas próprias contas, use o conector Sandbox com suas credenciais de teste. Sua conexão do Meu Pluggy é dados reais, nunca um sandbox.

Perguntas#

Dúvidas sobre uso pessoal vão para a comunidade no Discord: discord.com/invite/EanrwJADby.

Esta página foi útil?