Conexão REST genérica

A conexão REST genérica conecta o PlaidCloud a qualquer serviço HTTP/REST que não tenha um conector dedicado. Ela oferece suporte aos padrões de autenticação mais comuns (None, Basic, API Key, token de portador, OAuth 2.0), cabeçalhos de solicitação padrão, controle detalhado de redirecionamento e transporte, e um testador de solicitações no próprio formulário.

Conversores, como o importador Savant, podem criar conexões REST que guardam valores secretos criptografados. As etapas que eles convertem usam esses valores em tempo de execução.

Configuração

O formulário tem quatro guias.

Detalhes da conexão

Campo	Tipo	Descrição
Nome da conexão	Texto	Nome de exibição desta conexão.
Memo	Texto (várias linhas)	Observações opcionais sobre a conexão.
Host ou endereço IP	Texto	Host base para o qual as solicitações são enviadas.
Ativa (permitir acesso)	Alternância	Indica se a conexão está ativada. Desative para pausá-la sem excluí-la.
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, o grupo correspondente na guia Autenticação é ativado.
Modelo de segurança	Seleção	Quem pode usar a conexão: Privado, Membros específicos, Grupos de segurança específicos ou Todos os membros do espaço de trabalho.

Configurações da conexão

Configuração	Padrão	Descrição
Ativar verificação de certificado SSL	Desativado	Verifica os certificados SSL ao enviar uma solicitação. Falhas de verificação abortam a solicitação.
Seguir redirecionamentos automaticamente	Ativado	Trata respostas HTTP 3xx como redirecionamentos.
Seguir o método HTTP original	Desativado	Redireciona com o método HTTP original, em vez do padrão de redirecionar com GET.
Seguir cabeçalho Authorization	Desativado	Mantém o cabeçalho de autorização quando ocorre um redirecionamento.
Remover cabeçalho referer no redirecionamento	Desativado	Remove o cabeçalho referer quando ocorre um redirecionamento.
Ativar analisador HTTP estrito	Desativado	Rejeita respostas com cabeçalhos HTTP inválidos.
Codificar URL automaticamente	Ativado	Codifica o caminho da URL, os parâmetros de consulta e os campos de autenticação.
Desativar cookie jar	Desativado	Não armazena os cookies desta solicitação no cookie jar e não envia cookies armazenados como cabeçalhos.
Usar o conjunto de cifras do servidor durante o handshake	Desativado	Usa a ordem do conjunto de cifras do servidor, em vez da do cliente, durante o handshake.
Número máximo de redirecionamentos	10	Limite de redirecionamentos a seguir.

Definição da API

Opcional. Anexe à conexão a definição OpenAPI 3.x ou Swagger 2.0 da API, e qualquer etapa Solicitação REST que a use poderá listar os endpoints da API, com métodos, parâmetros e corpos de solicitação já preenchidos, sem repetir a definição em cada etapa.

Campo	Tipo	Descrição
Definição	Seleção	None, OpenAPI / Swagger URL ou OpenAPI / Swagger file.
URL da definição	Texto	Endereço em que a especificação está publicada, por exemplo https://api.example.com/openapi.json. Exibido quando você escolhe URL.
Arquivo de definição	Arquivo	Uma especificação .json ou .yaml armazenada em Documentos. Exibido quando você escolhe arquivo.

Em uma etapa Solicitação REST, escolha esta conexão, defina Origem do endpoint como Da definição de API da conexão e escolha Carregar catálogo.

Nota

A URL da definição precisa estar acessível pela internet. Se a especificação for publicada apenas dentro da sua própria rede, envie-a para Documentos e selecione-a como arquivo.

Autenticação

Somente o grupo correspondente ao Authentication Type selecionado é exibido. Com None, a guia fica desativada.

Básica

Campo	Tipo	Descrição
Usuário	Texto	Nome de usuário da autenticação básica.
Senha	Senha	Senha da autenticação básica (somente gravação).

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	Senha	Token de portador (somente gravação).

OAuth 2.0

Campo	Tipo	Descrição
Adicionar dados de autenticação a	Seleção	Envia os dados de autenticação em Request Headers ou em Request URL.
Prefixo do cabeçalho	Texto	Prefixo do valor do cabeçalho de autorização (padrão: Bearer).
URL de autenticação	Texto	Endpoint de autorização.
URL do token de acesso	Texto	Endpoint de token.
ID do cliente	Texto	Identificador do cliente OAuth.
Segredo do cliente	Texto	Segredo do cliente OAuth.
URL do token de atualização	Texto	Endpoint usado para atualizar o token.
Token de atualização inicial	Texto	Token de atualização inicial para a primeira troca.
Parâmetros adicionais da solicitação de token	Tabela	Parâmetros extras do corpo enviados nas solicitações de token (Ativado, Nome, Valor, Descrição).
Cabeçalhos adicionais da solicitação de token	Tabela	Cabeçalhos extras enviados nas solicitações de token (Ativado, Nome, Valor, Descrição).

Azure Cosmos DB (Chave mestra)

Campo	Tipo	Descrição
Chave mestra	Senha	A chave mestra da conta do Cosmos DB (somente gravação). Cada solicitação é assinada com ela, como a API REST do Cosmos DB exige.

Azure Cosmos DB (Microsoft Entra ID)

Campo	Tipo	Descrição
URL do token de acesso	Texto	O endpoint de token do seu tenant, como https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token.
ID do cliente	Texto	O ID do cliente do aplicativo Entra.
Segredo do cliente	Senha	O segredo do cliente do aplicativo Entra (somente gravação).

Use uma conexão do Cosmos DB com a etapa Solicitação REST para consultar os documentos de um contêiner e gravá-los. Defina a URL base da conexão como o endpoint da conta do Cosmos DB.

Cabeçalhos padrão

Uma tabela de cabeçalhos enviados em toda solicitação feita por esta conexão. Cada linha tem Enabled, Header Name, Value e Description. Use os botões da linha para adicionar, inserir e excluir cabeçalhos. Esses cabeçalhos são enviados com toda solicitação que a conexão faz, incluindo cada página de uma leitura paginada e cada solicitação em uma distribuição por linha; um cabeçalho definido em uma etapa individual tem precedência sobre um de mesmo nome definido aqui.

Teste

Dispare uma solicitação ad hoc pela conexão salva para confirmar que ela funciona.

Campo	Tipo	Descrição
Endpoint de teste	Texto	URL completa 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 da solicitação. Aceita tokens de modelo no estilo Django/Jinja.
Enviar solicitação de teste	Botão	Envia a solicitação e mostra a resposta (ou o erro).

Cuidado

Salve a conexão antes de enviar uma solicitação de teste: o teste é executado com a configuração armazenada, portanto uma conexão não salva é rejeitada.

Nota

Os campos de senha e token são somente de gravação. Eles 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 para alterá-lo.

Relacionados

• Conectores REST — conectores dedicados para Salesforce, NetSuite, Workday e outros serviços REST.
• Importar dados do Samsara — uma receita para copiar e colar, para uma API que usa paginação por cursor.
• Criar e gerenciar uma conexão
• Etapa de fluxo de trabalho Solicitação REST