Criar e gerir uma ligação

Uma ligação é uma configuração guardada que permite ao PlaidCloud aceder a um sistema externo — uma base de dados, um data lake, um ERP, uma API REST, um serviço na cloud ou um fornecedor de Git. Os passos de fluxo de trabalho referenciam a ligação pelo nome, pelo que os detalhes do ponto de acesso e as credenciais ficam num único local e são reutilizados em todos os passos e projetos que deles precisem.

As ligações são geridas em Tools > Connections.

Criar uma ligação

1. Abra Tools > Connections
2. Clique em New Connection na barra de ferramentas e escolha no menu o sistema a que pretende ligar-se
3. Preencha o formulário da ligação (os separadores e os campos variam consoante o tipo — consulte Formulário da ligação abaixo)
4. Clique em Create para guardar

A nova ligação aparece na lista, com o utilizador como proprietário.

Nota

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

Formulário da ligação

A maioria das ligações abre um formulário com vários separadores. Os separadores exatos dependem do tipo, mas verá normalmente:

• Configuração da ligação (ou Detalhes da ligação para REST) — o Name da ligação, um Memo opcional, o anfitrião/porta/base de dados (ou o anfitrião/tipo de autenticação para REST), o interruptor Usage (Active) e o Security Model. Numa ligação a uma base de dados, as credenciais ficam aqui, num grupo Credenciais de autenticação; numa ligação REST, têm o seu próprio separador Autenticação.
• Configuração SSL — Use SSL mais o modo SSL e certificados opcionais de cliente/raiz para uma ligação cifrada.
• Configuração SSH — Use SSH mais o anfitrião bastion, a porta, o utilizador e a chave para encapsular a ligação através de um anfitrião de salto SSH.

Os campos de palavra-passe, token e outras credenciais são apenas de escrita: aparecem em branco quando reabre uma ligação guardada, e deixá-los em branco ao guardar mantém o segredo armazenado. Volte a escrever um valor apenas quando o quiser alterar. Isto aplica-se à chave de API, ao segredo do cliente OAuth e ao token de atualização OAuth de uma ligaçã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, um URL de webhook de entrada do Slack ou do Teams — são apenas de escrita da mesma forma e ficam ocultas enquanto as escreve ou cola. Uma substituição composta apenas por espaços é recusada em vez de guardada por cima da credencial armazenada; limpe o campo para manter o valor guardado. A chave de cliente SSL e a chave privada SSH de uma ligação SQL ou Git também são apenas de escrita, mas permanecem visíveis enquanto as escreve. Todos os outros campos mostram o seu valor guardado real em todos os locais onde a ligação é apresentada, no editor e através da API, incluindo campos que parecem sensíveis pelo nome (o indicador de só de leitura de uma base de dados, um identificador de conta, um esquema, um nome de anfitrião) — apenas uma credencial verdadeira é alguma vez ocultada ou escondida.

Através da API REST e do MCP, um campo de credencial segue a mesma regra do editor: envie uma cadeia vazia e o PlaidCloud mantém o valor armazenado; envie null para o limpar. Todos os campos que não são credenciais continuam a ser limpos quando os envia em branco.

Os campos obrigatórios são validados ao guardar; se algo estiver em falta, o formulário passa para o separador que contém o primeiro campo inválido e assinala-o.

Modelo de segurança

O Security Model de uma ligação controla quem na área de trabalho a pode utilizar:

Opção	Quem pode utilizar a ligação
Privada (apenas proprietários)	Apenas os proprietários.
Apenas membros específicos	Os proprietários mais uma lista explícita de membros.
Apenas grupos de segurança específicos	Os proprietários mais os membros de grupos de segurança indicados.
Todos os membros da área de trabalho	Todos os que estão na área de trabalho.

Quando escolhe Specific Members Only ou Specific Security Groups Only, conceda o acesso no menu Actions da lista — Members para Specific Members Only ou Groups para Specific Security Groups Only, mais Agents e Owners, abrem cada um um seletor de lista dupla para adicionar e remover acesso. Apenas um proprietário da ligação, ou um administrador da área de trabalho, pode alterar o acesso aí. Qualquer outra pessoa que possa editar ligações pode abri-las para ver quem tem acesso, sem o alterar. Um administrador da área de trabalho pode alterar o acesso a uma ligação de que não é proprietário, para a transmitir quando os seus proprietários já saíram.

Ambientes

Uma ligação pode ter uma configuração diferente por ambiente (por exemplo, um anfitrião de desenvolvimento e um anfitrião de produção sob o mesmo nome de ligação). O seletor de ambiente na barra de ferramentas escolhe a configuração de qual ambiente está a ver e a editar.

• New Environment — adicionar um ambiente de ligação
• Edit Environment — mudar o nome do ambiente selecionado
• Delete Environment — remover o ambiente selecionado

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

Nota

Guardar uma configuração funde-a com a armazenada para esse ambiente, pelo que os segredos apenas de escrita deixados em branco nunca são substituídos por valores vazios.

Os ambientes são partilhados com os agentes PlaidLink, pelo que o ambiente de um projeto pode alternar o agente que executa os seus passos remotos, bem como as ligações que lê. Consulte Ambientes de agente.

Editar uma ligação

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

Testar uma ligação

A forma de testar depende do tipo:

• As ligações a bases de dados — Databricks, Snowflake, PostgreSQL e Redshift — têm um botão Testar ligação no editor. Abre a ligação com as credenciais que introduziu e comunica o sucesso (com a versão do servidor a que chegou) ou o motivo da falha, sem fechar o editor, para que possa corrigir e tentar novamente no mesmo local.
• As ligações a bases de dados com SSH expõem também um teste do túnel SSH no separador SSH Config.
• A ligação REST genérica tem um separador Testing que dispara um pedido ad hoc através da ligação guardada.

Guarde a ligação antes de testar — os testes são executados sobre a configuração armazenada.

Nota

Testar ligação aparece num tipo de ligação assim que o respetivo editor o oferece — atualmente os tipos de bases de dados acima, mais TM1, Oracle Essbase, HFM/FCCS, Salesforce e Anaplan. Outras ligações REST, como o NetSuite, ainda não o têm — teste-as enviando um pequeno pedido a partir de um passo de fluxo de trabalho (para o NetSuite, consulte Ligar ao NetSuite).

Clonar, eliminar e rastrear a utilização

• Clonar — duplique a configuração de uma ligação como base de uma nova. Consulte Clonar uma ligação.
• Eliminar — remova a ligação selecionada a partir da barra de ferramentas (é-lhe pedida confirmação).
• Onde é utilizado… — liste os passos de fluxo de trabalho que referenciam a ligação, para que possa ver o impacto antes de a editar ou eliminar.

Cuidado

Edit, Clone e Delete só estão disponíveis nas ligações de que é proprietário. Se essas ações estiverem a cinzento para a linha selecionada, não é proprietário — peça a um proprietário que faça a alteração ou que o adicione através de Owners.

Relacionado

• Referência de conectores — o catálogo completo de sistemas suportados e dos seus campos.
• Clonar uma ligação
• Origens Singer