Visão geral

O que é o Pluggy, os três objetos sobre os quais toda a API é construída e as duas maneiras de criar sua primeira integração.

Ver como Markdown

Pluggy é uma plataforma de open finance para a América Latina. Uma integração de API alcança centenas de instituições financeiras — contas bancárias, cartões de crédito, investimentos, empréstimos, identidade e pagamentos — e retorna seus dados em uma única forma normalizada, seja ela proveniente de um conector de Open Finance regulamentado ou de um dos próprios conectores da Pluggy.

Os três objetos#

Quase tudo na API é um desses, e o resto depende deles:

  • Connector — uma instituição financeira e os produtos que ela pode retornar.
  • Item — a conexão de um usuário através de um conector, criada após seu consentimento. É o ponto de entrada para seus dados e a coisa que você armazena do seu lado.
  • Product — os dados normalizados que um item fornece: contas, transações, investimentos, identidade, empréstimos.

O Glossary tem o restante do vocabulário; o guia Item cobre o ciclo de vida que você realmente passará seu tempo.

Duas maneiras de construir a primeira integração#

Ambas terminam no mesmo lugar — um item criado e suas transações na sua tela.

Aponte um agente para a documentação ao vivo#

Se você codifica com Claude, Cursor, Copilot, Codex ou Gemini, conecte-os à nossa documentação primeiro. É uma URL, hospedada, sem chave:

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

O agente então lê os guias atuais e a especificação OpenAPI em tempo de execução, em vez de recordar qualquer versão da nossa API que estava em seus dados de treinamento — a diferença entre código que roda e código que parece certo. A configuração para todos os outros clientes está na página MCP server, e o prompt que constrói todo o fluxo está no Quick Start.

Mais duas superfícies, para agentes que você não pode configurar: cada página aqui tem um gêmeo em markdown — adicione .md à sua URL — e /llms.txt indexa todos eles. Qualquer coisa que possa buscar uma URL pode ler nossos docs corretamente.

Ou siga os passos você mesmo#

O Quick Start é composto por cinco passos: crie um aplicativo, obtenha uma chave de API, emita um connect token, abra o widget, leia os dados. Nada neste site assume que você usa um agente.

Sandbox primeiro#

Novos aplicativos começam com acesso aos Sandbox connectors, para que você possa executar todo o fluxo — incluindo os casos de falha que você preferiria encontrar agora do que em produção — contra instituições falsas, sem credenciais reais envolvidas.

Esta página foi útil?