As credenciais (
clientId/secret) são apenas de entrada: o Matcher as sela antes de persistir e nunca as devolve em uma resposta, em um log ou em um erro. Cada resposta desta superfície é livre de segredos por construção. O tenant sempre vem do JWT, nunca do corpo da requisição.Criar uma conexão
vendor:pluggyoubelvo.configName: identidade única da conexão (no escopo do tenant). Uma duplicata é um409. O endpoint de emissão de token de webhook vincula um token a este nome.baseUrl: URL base da API do fornecedor, armazenada como host da conexão.accountRef: referência opaca e opcional da conta no fornecedor (itemIdda Pluggy, id do link da Belvo) repassada na busca por webhook. Omita para criar uma conexão que aguarda o consentimento do cliente final. Vincule depois comPUTa referência devolvida pelo fornecedor.clientId/secret: credencial da API do agregador, selada e nunca emitida.
201 com o descritor de conexão livre de segredos:
Listar, obter, atualizar, excluir
Atualizar
Edite uma conexão existente por id para que umabaseUrl digitada errado não fique permanente. O fornecedor é imutável. A credencial é opcional: informe os dois, clientId e secret, para rotacionar a credencial selada, ou omita os dois para manter intacto o segredo armazenado. Informar exatamente um é um 400.
Excluir
204), liberando o nome de configuração dela para reuso. Um id de conexão que não é de agregador retorna 404 em qualquer operação por id. Esta superfície nunca confirma a existência de uma linha que não é de agregador.
Testar uma conexão
Rode uma verificação de conectividade ao vivo para uma conexão existente e vinculada, usando a credencial já selada dela, endereçada por
configName. O fornecedor vem da conexão armazenada. Esta chamada não recebe credencial e não devolve nenhuma. Uma conexão que aguarda consentimento não é testável até a referência de conta no fornecedor estar vinculada.
Um resultado de credenciais que não funcionam é um resultado de teste esperado, mostrado como
"healthy": false com 200, não como erro. Uma conexão ausente ou um fornecedor armazenado sem caminho de teste de conectividade (hoje, a Belvo) aparece pela resposta de erro padrão. Nenhum teste roda. Use o campo testable da resposta da lista antes de oferecer a ação.Conectar uma conexão que aguarda consentimento
Para uma conexão criada sem
accountRef, emita um token de consentimento de vida curta e abra o widget de consentimento do próprio fornecedor no navegador do cliente final. A resposta carrega o token uma vez. O Matcher nunca o persiste e nunca o registra em log. Quando o widget devolve o id do item ou do link no fornecedor, vincule-o com PUT /v1/discovery/aggregator-connections/{id} e um corpo com accountRef. Você não precisa informar a credencial de novo.
reconsent: true com o accountRef vinculado exato. Use esse valor devolvido no widget do fornecedor, em vez de uma referência em cache local. Um deploy sem caminho de consentimento para o fornecedor retorna 422.
Tipos de conector
Liste os tipos de conector que o registro do motor de fato registrou para este deploy, cada um marcado com uma categoria derivada do backend (
database ou rest). A lista reflete o registro ao vivo. Apenas os conectores registrados no boot aparecem. Ela alimenta o seletor de tipo do formulário de conexão.
Emitir um token de webhook
Emita um token de webhook vinculado a uma conexão de agregador existente. A resposta carrega o token bruto e a URL de webhook voltada ao provedor uma vez. O Matcher armazena apenas o hash SHA-256 do token.
webhook_url devolvida no dashboard do agregador. Uma conexão de destino ausente retorna 404.