Pular para o conteúdo principal

Connect

Geração de tokens para o widget de conexão frontend. O token permite que o usuário final conecte suas contas bancárias de forma segura.

Fluxo de Conexão

  1. Seu backend gera um connect token via esta API
  2. O frontend usa o token no widget do provedor (ex: Pluggy Connect)
  3. O usuário autentica com sua instituição financeira
  4. O provedor retorna um externalItemId
  5. Seu backend sincroniza o item via POST /api/v1/items/sync

Gerar Token de Conexão

POST /api/v1/connect/token

Gera um token temporário para iniciar o fluxo de conexão no frontend.

Request

CampoTipoObrigatórioDescrição
configIdstringNãoID da configuração do provedor (usa o padrão se omitido)
webhookUrlstringNãoURL para receber webhooks desta conexão
clientUserIdstringNãoID do usuário no seu sistema
curl -X POST 'https://open-finance.stg.catalisa.app/api/v1/connect/token' \
-H 'Authorization: Bearer SEU_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"clientUserId": "usuario-123"
}'

Response (201 Created)

{
"data": {
"type": "openfinance-connect-token",
"attributes": {
"accessToken": "eyJhbGciOiJIUzI1NiIs...",
"expiresAt": "2024-01-15T11:30:00Z"
}
}
}

Exemplo: Integração com Widget

// 1. Gerar token no backend
const tokenResponse = await fetch('https://open-finance.stg.catalisa.app/api/v1/connect/token', {
method: 'POST',
headers: {
'Authorization': `Bearer ${backendToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ clientUserId: userId }),
});
const { data } = await tokenResponse.json();

// 2. Abrir widget no frontend (exemplo com Pluggy)
const pluggyConnect = new PluggyConnect({
connectToken: data.attributes.accessToken,
onSuccess: async (itemData) => {
// 3. Sincronizar item no backend
await fetch('https://open-finance.stg.catalisa.app/api/v1/items/sync', {
method: 'POST',
headers: {
'Authorization': `Bearer ${backendToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
externalItemId: itemData.item.id,
personId: customerId,
}),
});
},
});
pluggyConnect.init();