Criar e gerenciar uma conexão

Uma conexão é uma configuração salva que permite ao PlaidCloud acessar um sistema externo — um banco de dados, data lake, ERP, API REST, serviço em nuvem ou provedor Git. As etapas do fluxo de trabalho referenciam a conexão pelo nome, de modo que os detalhes do endpoint e as credenciais ficam em um só lugar e são reutilizados em todas as etapas e projetos que precisarem deles.

As conexões são gerenciadas em Tools > Connections.

Criar uma conexão

1. Abra Tools > Connections
2. Clique em New Connection na barra de ferramentas e escolha no menu o sistema ao qual deseja se conectar
3. Preencha o formulário da conexão (as guias e os campos variam conforme o tipo — consulte Formulário da conexão abaixo)
4. Clique em Create para salvar

A nova conexão aparece na lista, com você como proprietário.

Nota

A lista de tipos de conexão e os campos de que cada um precisa estão catalogados na referência de conectores. Para um serviço sem conector dedicado, use a Conexão REST genérica.

Formulário da conexão

A maioria das conexões abre um formulário com várias guias. As guias exatas dependem do tipo, mas você verá com frequência:

• Configuração da conexão (ou Detalhes da conexão para REST) — o Name da conexão, um Memo opcional, o host/porta/banco de dados (ou host/tipo de autenticação para REST), a opção Usage (Active) e o Security Model. Em uma conexão de banco de dados, as credenciais ficam aqui, em um grupo Credenciais de autenticação; em uma conexão REST, elas têm a própria guia Autenticação.
• Configuração de SSL — Use SSL mais o modo SSL e certificados opcionais de cliente/raiz para uma conexão criptografada.
• Configuração de SSH — Use SSH mais o host bastion, a porta, o usuário e a chave para tunelar a conexão por um host de salto SSH.

Os campos de senha, token e outras credenciais são somente de gravação: aparecem em branco quando você reabre uma conexão salva, e deixá-los em branco ao salvar mantém o segredo armazenado. Digite um valor novamente somente quando quiser alterá-lo. Isso vale para a chave de API, o segredo do cliente OAuth e o token de atualização OAuth de uma conexão REST. As credenciais de várias linhas — um certificado privado do NetSuite, um certificado e uma chave privada do Anaplan, uma chave de API do Postman, uma URL de webhook de entrada do Slack ou do Teams — também são somente de gravação e ficam mascaradas enquanto você as digita ou cola. Uma substituição composta apenas de espaços é recusada em vez de sobrescrever a credencial armazenada; limpe o campo para manter o valor salvo. A chave de cliente SSL e a chave privada SSH de uma conexão SQL ou Git também são somente de gravação, mas permanecem visíveis enquanto você as digita. Todos os outros campos mostram o valor salvo real em todos os lugares em que a conexão é exibida, no editor e pela API, inclusive os campos que parecem sensíveis pelo nome (o indicador de somente leitura de um banco de dados, um identificador de conta, um esquema, um nome de host) — somente uma credencial de verdade é mascarada ou ocultada.

Pela API REST e pelo MCP, um campo de credencial segue a mesma regra do editor: envie uma string vazia e o PlaidCloud mantém o valor armazenado; envie null para limpá-lo. Todos os campos que não são de credencial continuam sendo limpos quando você os envia em branco.

Os campos obrigatórios são validados ao salvar; se algo estiver faltando, o formulário muda para a guia que contém o primeiro campo inválido e o sinaliza.

Modelo de segurança

O Security Model de uma conexão controla quem no espaço de trabalho pode usá-la:

Opção	Quem pode usar a conexão
Privado (somente proprietários)	Somente os proprietários.
Somente membros específicos	Os proprietários mais uma lista explícita de membros.
Somente grupos de segurança específicos	Os proprietários mais os membros de grupos de segurança indicados.
Todos os membros do espaço de trabalho	Todos no espaço de trabalho.

Ao escolher Specific Members Only ou Specific Security Groups Only, conceda o acesso pelo menu Actions da lista — Members para Specific Members Only ou Groups para Specific Security Groups Only, além de Agents e Owners, cada um abre um seletor de lista dupla para adicionar e remover acessos. Somente um proprietário da conexão, ou um administrador do espaço de trabalho, pode alterar o acesso ali. Qualquer outra pessoa que possa editar conexões pode abri-las para ver quem tem acesso, sem alterá-lo. Um administrador do espaço de trabalho pode alterar o acesso a uma conexão que não é dele, para repassá-la quando os proprietários saíram.

Ambientes

Uma conexão pode manter uma configuração diferente por ambiente (por exemplo, um host de desenvolvimento e um host de produção sob o mesmo nome de conexão). O seletor de ambiente na barra de ferramentas escolhe a configuração de qual ambiente você está visualizando e editando.

• New Environment — adiciona um ambiente de conexão
• Edit Environment — renomeia o ambiente selecionado
• Delete Environment — remove o ambiente selecionado

A coluna Available na lista mostra se a conexão selecionada está configurada para o ambiente escolhido.

Nota

Salvar uma configuração a mescla com a armazenada para aquele ambiente, de modo que segredos somente de gravação deixados em branco nunca são sobrescritos por valores vazios.

Os ambientes são compartilhados com os agentes PlaidLink, de modo que o ambiente de um projeto pode alternar o agente que executa suas etapas remotas, bem como as conexões que ele lê. Consulte Ambientes de agente.

Editar uma conexão

1. Selecione a conexão na lista
2. Clique em Edit na barra de ferramentas (ou clique com o botão direito na linha)
3. Altere os campos e clique em Update

Testar uma conexão

A forma de testar depende do tipo:

• As conexões de banco de dados — Databricks, Snowflake, PostgreSQL e Redshift — têm um botão Testar conexão no editor. Ele abre a conexão com as credenciais que você informou e relata o sucesso (com a versão do servidor alcançado) ou o motivo da falha, sem fechar o editor, para que você possa corrigir e tentar novamente ali mesmo.
• As conexões de banco de dados com SSH também oferecem um teste do túnel SSH na guia SSH Config.
• A Conexão REST genérica tem uma guia Testing que dispara uma solicitação ad hoc pela conexão salva.

Salve a conexão antes de testar — os testes são executados na configuração armazenada.

Nota

Testar conexão aparece em um tipo de conexão assim que o editor dele o oferece — atualmente os tipos de banco de dados acima, mais TM1, Oracle Essbase, HFM/FCCS, Salesforce e Anaplan. Outras conexões REST, como o NetSuite, ainda não o têm — faça um teste rápido enviando uma pequena solicitação a partir de uma etapa do fluxo de trabalho (para o NetSuite, consulte Conectar ao NetSuite).

Clonar, excluir e rastrear o uso

• Clonar — duplica a configuração de uma conexão como base para uma nova. Consulte Clonar uma conexão.
• Excluir — remove a conexão selecionada pela barra de ferramentas (será solicitada uma confirmação).
• Onde é usado… — lista as etapas do fluxo de trabalho que referenciam a conexão, para que você veja o impacto antes de editá-la ou excluí-la.

Cuidado

Edit, Clone e Delete só estão disponíveis em conexões das quais você é proprietário. Se essas ações estiverem esmaecidas para a linha selecionada, você não é proprietário — peça a um proprietário que faça a alteração ou que adicione você por meio de Owners.

Relacionados

• Referência de conectores — o catálogo completo dos sistemas compatíveis e seus campos.
• Clonar uma conexão
• Fontes Singer