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

Criar Connect Token

Cria um connect token

Para criar um connect token, é necessário estar pré-autorizado na API da Pluggy com a CHAVE DA API.

Opções#

  • clientUserId: Forneça este valor para rastreabilidade de ponta a ponta da conexão do seu usuário. Você pode enviar qualquer referência para o usuário que deseja usar, e ela estará disponível para cada item criado no Pluggy Connect Widget que usou este connectToken.
  • webhookUrl: Ao fornecer este valor, ele funciona da mesma forma que criar um item com o parâmetro webhookUrl. Ele enviará todos os eventos do item para essa URL, além dos outros webhooks configurados no nível do cliente.
  • oauthRedirectUri: URL para redirecionar o usuário após o fluxo de conexão.
  • avoidDuplicates: Evita a criação de um novo item se já houver um com as mesmas credenciais.

Atualizações#

Além do objeto options, ao atualizar um item, o itemId deve ser fornecido para garantir a conexão do widget a esse Item específico. Um erro de segurança será fornecido se não for fornecido e a atualização não estará disponível.



Request Body

Criar payload do connect token

object

Crie um payload de solicitação de token de conexão

itemIdstring (uuid)

Identificador do Item para permitir que o Connect Widget realize uma atualização nele.

optionsobject

Opções de item disponíveis para enviar através de connect tokens

clientUserIdstring

Identificador externo do cliente para o usuário, pode ser um ID, UUID ou até mesmo um e-mail. Isso é livre para os clientes usarem.

webhookUrlstring

Public https url to be notified of this specific item changes. Same rules as the `url` of a webhook: default port (443) only, no username or password, at most 2048 characters, and a domain name (not an IP address, localhost or an internal name) that resolves only to public IP addresses. Otherwise the request fails with 400. Deliveries to this url are signed like any other webhook of the application: when the application has a webhook signing secret, each one carries the `X-Pluggy-Signature` header (see [Webhook security](https://docs.pluggy.ai/docs/developer-tools/webhook-security)).

oauthRedirectUristring

Url para redirecionar o usuário após o fluxo de conexão

avoidDuplicatesboolean

Evita criar um novo item se já houver um com as mesmas credenciais

productsstring[]

Produtos a serem coletados em itens criados ou atualizados com este connect token. Usado apenas quando a solicitação do item não envia seus próprios produtos.

Example

json
{
  "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "options": {
    "webhookUrl": "https://example.com/webhook",
    "clientUserId": "My App UserId",
    "oauthRedirectUri": "https://pluggy.ai/demo",
    "avoidDuplicates": true
  }
}

Responses

200Token de conexão criado
object

Resposta do token de conexão

accessTokenrequiredstring

Token de conexão usado para inicializar o Connect Widget da Pluggy

Example response

json
{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjI3MzY0YjRhLTM1NGUtNDc5ZC04OWJkLTA1Y2VmNDc2ZTFmNCIsImRhdGEiOiI4NmYyMjIwNDVkNjc3NDJjZjI5MjhjMGNmNjBlZjFkZjo5MjRmNGZlNjg5YWM1NGI2ZmVmMzkzZDc2ZTExNjAxZTI1MjliNmUyNDY1Y2I4ZDkxMWI3ZDY0ZjA5Y2NkYzBiMzg4YWFjZWNkZmQzMGMzZGZiNTBkNzk1OTA1Y2QyNWZlZmEyODZhMWQ0NDc5YzYyNzgwZDZiMzBlNDZiYTY3YjUyZDRkMmIwNWU0ODVjYzk5NjZiYzJjMDUyNDE5OTgzNjBjYTVkM2M4MTJhODQ0ODI1NDI2NDJhNWNkNjhjMTU3YjUzYThkOGEyOGZlMWM4ZDkxNmYzZjZlOTQ0MzEyYjBjNzNmZDBhYmIyYTk0MDU2MzZhYjMxM2RkMmY0OTE0IiwiaWF0IjoxNjQwNjk3MjUwLCJleHAiOjE2NDA2OTkwNTB9.i9DpZ_sOW_I9yGUUXqUWcB9zqCJEXQnjaUrwmcVOXX3F1-he3LjT2f8mHbt7DOvxHtxqAagZkW8BT3J2OBYDOzmHuBgKbbSUmb4YLfC8PaKf2p7fY0fKVu30iIFqiM5CgDQ048dIWzWSlGAYZq00edD0BYlfOkU3ll7OofzmDUAG6KBRDx68FrtYxboNJa8sXli7WSAI3nzZDhcVyPJvqlMHG6VXbJboQrxnSEBGdpGBQ7n_-2G5Oa3-MHCR-Z5cKx1pi4NwqorGFg1c2uRj3F4GdRs94UkqlvdH6FRxAUD3SVDiegvQ6vkOWCHpD1-wZELOmenkJ7ecjg9CChPavx"
}
curl -X POST \
'https://api.pluggy.ai/connect_token' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY' \
-d '{ "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f", "options": { "webhookUrl": "https://example.com/webhook", "clientUserId": "My App UserId", "oauthRedirectUri": "https://pluggy.ai/demo", "avoidDuplicates": true } }'
Resposta de exemplo
{
"accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjI3MzY0YjRhLTM1NGUtNDc5ZC04OWJkLTA1Y2VmNDc2ZTFmNCIsImRhdGEiOiI4NmYyMjIwNDVkNjc3NDJjZjI5MjhjMGNmNjBlZjFkZjo5MjRmNGZlNjg5YWM1NGI2ZmVmMzkzZDc2ZTExNjAxZTI1MjliNmUyNDY1Y2I4ZDkxMWI3ZDY0ZjA5Y2NkYzBiMzg4YWFjZWNkZmQzMGMzZGZiNTBkNzk1OTA1Y2QyNWZlZmEyODZhMWQ0NDc5YzYyNzgwZDZiMzBlNDZiYTY3YjUyZDRkMmIwNWU0ODVjYzk5NjZiYzJjMDUyNDE5OTgzNjBjYTVkM2M4MTJhODQ0ODI1NDI2NDJhNWNkNjhjMTU3YjUzYThkOGEyOGZlMWM4ZDkxNmYzZjZlOTQ0MzEyYjBjNzNmZDBhYmIyYTk0MDU2MzZhYjMxM2RkMmY0OTE0IiwiaWF0IjoxNjQwNjk3MjUwLCJleHAiOjE2NDA2OTkwNTB9.i9DpZ_sOW_I9yGUUXqUWcB9zqCJEXQnjaUrwmcVOXX3F1-he3LjT2f8mHbt7DOvxHtxqAagZkW8BT3J2OBYDOzmHuBgKbbSUmb4YLfC8PaKf2p7fY0fKVu30iIFqiM5CgDQ048dIWzWSlGAYZq00edD0BYlfOkU3ll7OofzmDUAG6KBRDx68FrtYxboNJa8sXli7WSAI3nzZDhcVyPJvqlMHG6VXbJboQrxnSEBGdpGBQ7n_-2G5Oa3-MHCR-Z5cKx1pi4NwqorGFg1c2uRj3F4GdRs94UkqlvdH6FRxAUD3SVDiegvQ6vkOWCHpD1-wZELOmenkJ7ecjg9CChPavx"
}