HTTP > Make an API Key Authorization request

Credentials

Selecione a chave que contém suas credenciais de autenticação de Chave de API. Para adicionar uma nova chave, clique em Add e configure as seguintes informações:

• Key name

  Insira um nome para este conjunto de credenciais de API.

• Key

  Insira a chave da API.

• API Key placement

  Selecione se deseja colocar a chave de API no cabeçalho ou no query da chamada de API.

• API Key parameter name

  Insira o nome pelo qual a chamada de API identifica a chave da API, como "apiKey" ou "X-API-Key". Você pode encontrar essas informações na documentação do serviço Web ao qual o módulo está se conectando.

Evaluate all states as errors (except for 2xx and 3xx)

Use esta opção para configurar o tratamento de erros.

Para obter mais informações, consulte Tratamento de erros.

URL

Insira o URL para o qual você deseja enviar uma solicitação, como um endpoint de API, site etc.

Method

Selecione o método de solicitação HTTP necessário para configurar a chamada de API. Para obter mais informações, consulte Métodos de solicitação HTTP.

Headers

Adicione os cabeçalhos da solicitação no formulário de um objeto JSON padrão. Por exemplo, {"Content-type":"application/json"}

Query String

Insira os pares de valor-chave da consulta desejados.

Body type

O Corpo HTTP são os bytes de dados transmitidos em uma mensagem de transação HTTP imediatamente após os cabeçalhos, se houver algum a ser usado.

• Raw

  O tipo de corpo bruto geralmente é adequado para a maioria das solicitações de corpo HTTP, mesmo em situações em que a documentação do desenvolvedor não especifica os dados a serem enviados.

  Especifique um formulário de análise de dados no campo Content type.

  Apesar do tipo de conteúdo selecionado, o módulo insere dados em qualquer formato estipulado ou exigido pela documentação do desenvolvedor.

• Application/x-www-form-urlencoded

  Este tipo de corpo é para dados POST usando application/x-www-form-urlencoded.

  Para application/x-www-form-urlencoded, o corpo da mensagem HTTP enviada ao servidor é essencialmente uma cadeia de caracteres de consulta. As chaves e os valores são codificados em pares de valores chave separados por & e por um = entre a chave e o valor.

  Para dados binários, use multipart/form-data.

  Exemplo:

  Exemplo do formato de solicitação HTTP resultante:

  field1=value1&field2=value2

• Multipart/form-data

  O Multipart/form-data é uma solicitação HTTP de várias partes usada para enviar arquivos e dados. Normalmente, é usado para carregar arquivos no servidor.

  Adicione campos a serem enviados na solicitação. Cada campo deve conter um par de valor-chave.

  • Text

    Informe a chave e o valor a serem enviados dentro do corpo da solicitação.

  • File

    Informe a chave e especifique o arquivo de origem que deseja enviar no corpo da solicitação.

    Mapeie o arquivo que você deseja carregar do módulo anterior (como HTTP > Get a File ou Google Drive >Download a File) ou insira o nome do arquivo e os dados do arquivo manualmente.

Parse response

Habilite esta opção para analisar respostas automaticamente e converter respostas JSON e XML para que você não precise usar os módulos JSON > Parse JSON ou XML > Parse XML.

Antes de usar o conteúdo JSON ou XML analisado, execute o módulo uma vez manualmente para que o módulo possa reconhecer o conteúdo da resposta e permitir que você o mapeie em módulos subsequentes.

Timeout

Especifique o tempo limite da solicitação em segundos (1-300). O padrão é 40 segundos.

Share cookies with other HTTP modules

Habilite essa opção para compartilhar cookies do servidor com todos os módulos HTTP em seu cenário.

Self-signed certificate

Para adicionar um certificado autoassinado:

1. Clique em Extract.

2. Selecione o tipo de arquivo que você está extraindo.

3. Selecione o arquivo que contém o certificado ou.

4. Digite a senha do arquivo.

5. Clique em Save para extrair o arquivo e retornar à configuração do módulo.

Reject connections that are using unverified (self-signed) certificates

Habilite esta opção para rejeitar conexões que estejam usando certificados TLS não verificados.

Follow redirect

Ative essa opção para seguir os redirecionamentos de URL com respostas 3xx.

Follow all redirects

Ative essa opção para seguir os redirecionamentos de URL com todos os códigos de resposta.

Disable serialization of multiple same query string keys as arrays

Por padrão, Workfront Fusion manipula vários valores para a mesma chave de parâmetro da cadeia de caracteres de consulta da URL que as matrizes. Por exemplo, www.test.com?foo=bar&foo=baz será convertido em www.test.com?foo[0]=bar&foo[1]=baz. Ative esta opção para desativar este recurso.

Request compressed content

Habilite esta opção para solicitar uma versão compactada do site.

Adiciona um cabeçalho Accept-Encoding para solicitar conteúdo compactado.

Use Mutual TLS

Habilite esta opção para usar o TLS mútuo na solicitação HTTP.

Para obter mais informações sobre TLS Mútuo, consulte Usar TLS Mútuo em módulos HTTP em Adobe Workfront Fusion.