Ligação REST genérica

A ligação REST genérica liga o PlaidCloud a qualquer serviço HTTP/REST que não tenha um conector dedicado. Suporta os padrões de autenticação mais comuns (Nenhuma, Básica, Chave de API, token de portador, OAuth 2.0), cabeçalhos de pedido predefinidos, um controlo detalhado do tratamento de redirecionamentos e do transporte, e um testador de pedidos integrado no formulário.

Os conversores, como o importador Savant, podem criar ligações REST que contêm valores secretos cifrados. Os passos que convertem utilizam esses valores durante a execução.

Configuração

O formulário tem quatro separadores.

Detalhes da ligação

Campo	Tipo	Descrição
Nome da ligação	Texto	Nome de apresentação desta ligação.
Memo	Texto (várias linhas)	Notas opcionais sobre a ligação.
Anfitrião ou endereço IP	Texto	Anfitrião base ao qual se dirigem os pedidos.
Ativa (permitir acesso)	Comutador	Indica se a ligação está ativada. Desative para a suspender sem a eliminar.
Tipo de autenticação	Seleção	None, Basic, API Key, Bearer Token, OAuth 2.0, Azure Cosmos DB (Master Key) ou Azure Cosmos DB (Microsoft Entra ID). Ao selecionar um tipo, ativa o grupo correspondente no separador Autenticação.
Modelo de segurança	Seleção	Quem pode utilizar a ligação — Privado, Membros específicos, Grupos de segurança específicos ou Todos os membros da área de trabalho.

Definições da ligação

Definição	Predefinição	Descrição
Ativar a verificação do certificado SSL	Desativado	Verifica os certificados SSL ao enviar um pedido. As falhas de verificação interrompem o pedido.
Seguir redirecionamentos automaticamente	Ativado	Trata as respostas HTTP 3xx como redirecionamentos.
Seguir o método HTTP original	Desativado	Redireciona com o método HTTP original em vez de redirecionar com GET, que é o comportamento predefinido.
Seguir o cabeçalho Authorization	Desativado	Mantém o cabeçalho de autorização quando ocorre um redirecionamento.
Remover o cabeçalho referer no redirecionamento	Desativado	Remove o cabeçalho referer quando ocorre um redirecionamento.
Ativar o analisador HTTP estrito	Desativado	Rejeita respostas com cabeçalhos HTTP inválidos.
Codificar o URL automaticamente	Ativado	Codifica o caminho do URL, os parâmetros de consulta e os campos de autenticação.
Desativar o repositório de cookies	Desativado	Não guarda os cookies deste pedido no repositório de cookies e não envia como cabeçalhos os cookies guardados.
Usar o conjunto de cifras do servidor durante o handshake	Desativado	Utiliza a ordem do conjunto de cifras do servidor em vez da do cliente durante o handshake.
Número máximo de redirecionamentos	10	Limite do número de redirecionamentos a seguir.

Definição da API

Opcional. Anexe à ligação a definição OpenAPI 3.x ou Swagger 2.0 da API, e qualquer passo Pedido REST que a utilize pode listar os pontos de acesso da API — com os respetivos métodos, parâmetros e corpos de pedido preenchidos — sem repetir a definição em cada passo.

Campo	Tipo	Descrição
Definição	Seleção	None, OpenAPI / Swagger URL ou OpenAPI / Swagger file.
URL da definição	Texto	Endereço onde a especificação está publicada, por exemplo https://api.example.com/openapi.json. Apresentado quando escolhe URL.
Ficheiro de definição	Ficheiro	Uma especificação .json ou .yaml armazenada no Document. Apresentado quando escolhe ficheiro.

Num passo Pedido REST, escolha esta ligação, defina Origem dos pontos finais como A partir da definição da API da ligação e, em seguida, escolha Carregar catálogo.

Nota

O URL de uma definição tem de estar acessível a partir da Internet. Se a especificação estiver publicada apenas na sua própria rede, carregue-a para o Document e selecione-a como ficheiro.

Autenticação

Só é apresentado o grupo que corresponde ao Authentication Type selecionado. Com None, o separador fica desativado.

Básica

Campo	Tipo	Descrição
Utilizador	Texto	Nome de utilizador da autenticação básica.
Palavra-passe	Palavra-passe	Palavra-passe da autenticação básica (só de escrita).

Chave de API

Campo	Tipo	Descrição
Chave	Texto	Nome do campo da chave de API.
Valor	Texto	Valor da chave de API.

Token de portador

Campo	Tipo	Descrição
Token	Palavra-passe	Token de portador (só de escrita).

OAuth 2.0

Campo	Tipo	Descrição
Adicionar dados de autenticação a	Seleção	Envia os dados de autenticação nos Request Headers ou no Request URL.
Prefixo do cabeçalho	Texto	Prefixo do valor do cabeçalho de autorização (por predefinição, Bearer).
URL de autenticação	Texto	Ponto de acesso de autorização.
URL do token de acesso	Texto	Ponto de acesso do token.
ID do cliente	Texto	Identificador do cliente OAuth.
Segredo do cliente	Texto	Segredo do cliente OAuth.
URL do token de atualização	Texto	Ponto de acesso utilizado para atualizar o token.
Token de atualização inicial	Texto	Token de atualização inicial para a primeira troca.
Parâmetros adicionais do pedido de token	Tabela	Parâmetros adicionais do corpo enviados nos pedidos de token (Ativado, Nome, Valor, Descrição).
Cabeçalhos adicionais do pedido de token	Tabela	Cabeçalhos adicionais enviados nos pedidos de token (Ativado, Nome, Valor, Descrição).

Azure Cosmos DB (Chave mestra)

Campo	Tipo	Descrição
Chave mestra	Palavra-passe	A chave mestra da conta do Cosmos DB (só de escrita). Cada pedido é assinado com ela, conforme exigido pela API REST do Cosmos DB.

Azure Cosmos DB (Microsoft Entra ID)

Campo	Tipo	Descrição
URL do token de acesso	Texto	O ponto de acesso de tokens do seu inquilino, como https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token.
ID do cliente	Texto	O ID de cliente da aplicação Entra.
Segredo do cliente	Palavra-passe	O segredo de cliente da aplicação Entra (só de escrita).

Utilize uma ligação Cosmos DB com o passo Pedido REST para consultar os documentos de um contentor e escrevê-los. Defina o URL base da ligação como o ponto de acesso da conta do Cosmos DB.

Cabeçalhos predefinidos

Uma tabela de cabeçalhos enviados em todos os pedidos através desta ligação. Cada linha tem Enabled, Header Name, Value e Description. Utilize os botões da linha para adicionar, inserir e eliminar cabeçalhos. Estes cabeçalhos são enviados com todos os pedidos que a ligação faz, incluindo cada página de uma leitura paginada e cada pedido numa expansão por linha; um cabeçalho definido num passo individual tem precedência sobre um com o mesmo nome aqui definido.

Teste

Envie um pedido ad hoc através da ligação guardada para confirmar que funciona.

Campo	Tipo	Descrição
Ponto de acesso de teste	Texto	URL completo a chamar (por exemplo, https://example.com/rest/test/validate).
Método	Seleção	GET, PUT, POST, DELETE, HEAD ou OPTIONS.
Payload	Código	Corpo do pedido. Suporta tokens de modelo ao estilo Django/Jinja.
Enviar pedido de teste	Botão	Envia o pedido e mostra a resposta (ou o erro).

Cuidado

Guarde a ligação antes de enviar um pedido de teste — o teste é executado com a configuração guardada, pelo que uma ligação não guardada é rejeitada.

Nota

Os campos de palavra-passe e de token são só 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 para o alterar.

Relacionado

• Conectores REST — conectores dedicados para Salesforce, NetSuite, Workday e outros serviços REST.
• Importar dados da Samsara — uma receita para copiar e colar para uma API que utiliza paginação por cursor.
• Criar e gerir uma ligação
• Passo de fluxo de trabalho Pedido REST