PluggyDocs

Início Rápido

Comece a usar o Pluggy em minutos.

Obtenha sua primeira conexão funcionando com a Pluggy em poucos minutos. Com uma única API, a Pluggy traz os dados financeiros dos seus usuários para que você possa construir produtos únicos para seus clientes.

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 aplicação#

  1. Inscreva-se no Pluggy Dashboard.
  2. Crie uma aplicação. Cada aplicação tem seu próprio CLIENT_ID e CLIENT_SECRET -- você os encontrará na página da aplicação no Dashboard.

Novas aplicações 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. Este passo deve ser feito a partir do seu servidor -- nunca exponha seu CLIENT_SECRET no código do lado do cliente.

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:

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

3. Crie um Connect Token#

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

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 Autenticação para os detalhes completos sobre escopos e opções.

4. Abra o Connect Widget#

Use o Connect Widget no seu frontend, inicializado com o accessToken da etapa anterior. O widget gerencia 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:

# 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#