PluggyDocs

Início Rápido

Crie seu primeiro item e leia suas transações — com um agente conectado à documentação ao vivo, ou manualmente.

Ver como Markdown

Ao final desta página, um usuário terá conectado uma instituição financeira e você estará lendo suas contas e transações. Cinco etapas, qualquer que seja o caminho que você seguir: crie um aplicativo, obtenha uma chave de API, emita um token de conexão, abra o widget, leia os dados.

Construa com um agente#

Seu agente pode escrever essa integração, e ele escreve uma muito melhor quando está lendo nossa documentação atual em vez de lembrar uma versão mais antiga dela.

1. Conecte os docs#

Uma URL hospedada, sem chave de API, nada para instalar:

bash
claude mcp add --transport http pluggy-docs https://mcp.pluggy.ai/mcp

Cursor, ChatGPT, Codex, VS Code, Windsurf e Gemini cada um utiliza a mesma URL em sua própria configuração — o trecho exato para cada um está na página do MCP server. Adicionar nossa Agent Skill por cima fornece os padrões de integração para acompanhar a referência.

2. Descreva o que você quer#

Cole isso, com sua pilha preenchida:

text
Use o servidor MCP do Pluggy Docs (pluggy-docs) para cada pergunta sobre o Pluggy — leia os guias atuais e a especificação OpenAPI antes de escrever código, e cite as páginas que você usou.
 
Construa uma integração mínima do Pluggy em <sua linguagem / framework>:
 
1. Uma rota de servidor que troca CLIENT_ID e CLIENT_SECRET por uma chave de API.
2. Uma rota de servidor que emite um token de conexão para um usuário específico.
3. Uma página frontend que abre o widget Pluggy Connect com esse token e
   armazena o itemId de seu callback onSuccess.
4. Uma rota de servidor que lista as contas e transações desse item,
   lidando com paginação.
 
Regras: CLIENT_SECRET nunca sai do servidor, as credenciais vêm de variáveis de ambiente, e o status do item é tratado — nem toda conexão está pronta no momento em que o widget fecha.

Então, faça a ele as perguntas que você teria pesquisado — por que este item está em WAITING_USER_INPUT?, o que significa este evento de webhook? — e ele responderá a partir das mesmas páginas que você está lendo agora.

3. O que ainda é sua responsabilidade#

Um agente não pode se inscrever por você. Crie a conta e o aplicativo na etapa 1 abaixo, coloque as credenciais em seu ambiente e leia o código que ele escreveu antes de executá-lo contra qualquer coisa real — o Sandbox existe exatamente para isso.

Sem agente, ou um que você não pode configurar?

Cada página aqui tem um gêmeo em markdown: adicione .md a qualquer URL de docs. O índice completo está em /llms.txt, o site inteiro como um arquivo está em /llms-full.txt, e a especificação OpenAPI está em /openapi/pluggy-api.json. O botão Copy for LLM no topo de cada página fornece a mesma coisa para uma única página.

Ou faça manualmente#

Comece ainda mais rápido

Confira nosso repositório de quickstart no GitHub -- ele contém aplicativos de exemplo prontos para rodar (Node, Python, Java e exemplos de frontend) que implementam todo esse fluxo.

1. Crie sua conta e aplicativo#

  1. Inscreva-se no Pluggy Dashboard.
  2. Crie um aplicativo. Cada aplicativo tem seu próprio CLIENT_ID e CLIENT_SECRET -- você os encontrará na página do aplicativo no Dashboard.

Novos aplicativos começam com acesso aos nossos connectors do Sandbox, para que você possa testar todo o fluxo com instituições falsas antes de ir para a produção.

2. Obtenha uma chave de API#

Autentique-se com suas credenciais para obter uma chave de API. Esta etapa deve ser feita a partir do seu servidor -- nunca exponha seu CLIENT_SECRET no código do lado do cliente.

bash
curl -X POST https://api.pluggy.ai/auth \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "YOUR_CLIENT_ID",
    "clientSecret": "YOUR_CLIENT_SECRET"
  }'

A resposta contém um apiKey, válido por 2 horas, com acesso total à API:

json
{
  "apiKey": "eyJhbGciOiJIUzI1..."
}

3. Crie um Token de Conexão#

Para permitir que seus usuários conectem suas contas a partir do seu aplicativo, crie um Token de Conexão de curta duração (válido por 30 minutos) com sua chave de API:

bash
curl -X POST https://api.pluggy.ai/connect_token \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -d '{}'

A resposta contém um accessToken -- este é o token que você passa para o widget. Veja Authentication para os detalhes completos sobre escopos e opções.

4. Abra o Connect Widget#

Use o Connect Widget em seu frontend, inicializado com o accessToken da etapa anterior. O widget lida com todo o fluxo de autenticação com a instituição financeira e cria um Item -- a representação da conexão do usuário. Pegue o itemId do evento onSuccess do widget.

5. Busque os dados#

Com a conexão criada, use sua chave de API (lado do servidor) para recuperar os dados:

bash
# Liste as contas da conexão
curl "https://api.pluggy.ai/accounts?itemId=YOUR_ITEM_ID" \
  -H "X-API-KEY: YOUR_API_KEY"
 
# Liste as transações de uma conta
curl "https://api.pluggy.ai/transactions?accountId=YOUR_ACCOUNT_ID" \
  -H "X-API-KEY: YOUR_API_KEY"

Próximos passos#

Esta página foi útil?