Variáveis Jitterbit da API no Integration Studio

Introdução

Esta página abrange variáveis Jitterbit que estão disponíveis para APIs personalizadas Jitterbit, organizadas por variáveis informativas que você lê (Informativo) e variáveis de configuração que você escreve (Configurações).

Variáveis terminadas em asterisco (*) significam que o asterisco deve ser substituído por um nome de cabeçalho, como em jitterbit.target.http.response.header.X-Jitterbit-Authorization.

Para obter informações detalhadas sobre o uso de APIs personalizadas do Jitterbit, consulte API Manager.

Informativo

jitterbit.api.request.body e jitterbit.api.request.body.*

Tipo de dados

Corda

Descrição

Olha para o payload/payloads submetidos à API. Note que para a maioria das APIs, você esperaria apenas um payload simples e, como tal, jitterbit.api.request.body é a variável a ser usada (também conhecida como content-type:text/plain).

Se você espera que várias cargas úteis sejam enviadas de uma vez, usando o formulário codificado por URL(também conhecido como content-type:application/x-www-form-urlencoded), como no caso de uma API sendo usada como backend de um formulário de envio (veja http://www.w3.org/TR/html401/interact/forms.html), então você deve usar jitterbit.api.request.body.*. Como com jitterbit.api.request.parameters.*, jitterbit.api.request.body.name será igual a EStore se o valor do campo "nome" do formulário foi inserido como EStore.

jitterbit.api.request.enum.body

Tipo de dados

Corda

Descrição

Matriz de variáveis usada para iterar dinamicamente por todas as partes enviadas da payload/corpo (em vez de verificar uma parte específica como com jitterbit.api.request.body.*). O uso é o mesmo que com o jitterbit.api.request.enum.parameters.

jitterbit.api.request.enum.headers

Tipo de dados

Corda

Descrição

Matriz de variáveis usada para iterar dinamicamente por todos os cabeçalhos de solicitação (em vez de verificar um cabeçalho específico como com jitterbit.api.request.headers.*). O uso é o mesmo que com o jitterbit.api.request.enum.parameters e jitterbit.api.request.enum.body.

jitterbit.api.request.enum.mvparameters

Tipo de dados

Corda

Descrição

Matriz de variáveis usada para iterar dinamicamente por todos os parâmetros multivalor (em oposição à verificação de cada parâmetro especificamente como jitterbit.api.request.mvparameters.ProdID).

jitterbit.api.request.enum.parameters

Tipo de dados

Corda

Descrição

Matriz de variáveis usada para iterar dinamicamente por todos os parâmetros enviados (em oposição à verificação de cada parâmetro especificamente como jitterbit.api.request.parameters.name).

Este script de exemplo anexa todos os parâmetros fornecidos a uma nova variável para exibição posterior ao usuário:

<trans>
$output = "URL Parameters: <br>\r\n";
enum = $jitterbit.api.request.enum.parameters;
i = 0;
while(i<length(enum),
  name = enum[i];
  $output = $output + "$" + name + ": " + Get(name) + " <br>\r\n";
  i = i+1;
 );
if(i==0, $output = $output + "(none)<br>\r\n");
</trans>

jitterbit.api.request.headers.*

Tipo de dados

Corda

Descrição

Esta variável Jitterbit retorna o valor do cabeçalho especificado que está sendo enviado na solicitação da API. O asterisco (*) deve ser substituído pela chave do cabeçalho.

Por exemplo, a variável jitterbit.api.request.headers.x_forwarded_for retorna o IP público da caixa/usuário que acessa a URL.

Ambos os cabeçalhos padrão em RFC 9110 e cabeçalhos personalizados são suportados. Para determinar quais chaves de cabeçalho estão sendo enviadas, consulte a documentação do OpenAPI por meio do API Manager Portal e Gerenciador do Portal páginas.

Exemplos

// Returns the value of the Content-Type header
Get('jitterbit.api.request.headers.Content-Type')

// Returns the value of the x_forwarded_for header
Get('jitterbit.api.request.headers.x_forwarded_for')

// Returns the value of the x_forwarded_for header
$jitterbit.api.request.headers.x_forwarded_for

// Returns the value of the my-custom-key header
Get('jitterbit.api.request.headers.my-custom-key')

// Returns the value of the My_Custom_Key header
Get('jitterbit.api.request.headers.My_Custom_Key')

// Returns the value of the My_Custom_Key header
$jitterbit.api.request.headers.My_Custom_Key

jitterbit.api.request.headers.fulluri

Tipo de dados

Corda

Descrição

A URL que foi chamada para acionar o Jitterbit OData ou a API personalizada.

jitterbit.api.request.method

Tipo de dados

Corda

Descrição

O método de solicitação que foi usado para chamar a API.

jitterbit.api.request.mvparameters.*

Tipo de dados

Corda

Descrição

Analisa os múltiplos valores do parâmetro enviado à API diretamente por meio da URL e retorna os valores como uma matriz com um espaço entre cada valor.

Por exemplo, se o URL for https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, então jitterbit.api.request.mvparameters.ProdID vai ser abc abc1 abc2.

jitterbit.api.request.parameters.*

Tipo de dados

Corda

Descrição

Analisa os parâmetros enviados à API diretamente por meio da URL; por exemplo, jitterbit.api.request.parameters.name será igual a EStore se a URL solicitada tivesse &name=EStore.

Configurações

jitterbit.api.response

Tipo de dados

Corda

Descrição

Esta variável deve ser definida se sua API personalizada está configurado para usar uma Variável de Sistema como o tipo de resposta. O jitterbit.api.response A variável pode ser usada várias vezes ao longo de uma cadeia de operação, mas deve ser definida para cada uso.

jitterbit.api.response.blank_error_response

Tipo de dados

Booleano

Descrição

Permite que uma resposta de API em branco seja retornada para não200-digite códigos de status quando jitterbit.api.response.blank_error_response está definido para true. Quando definido para false (padrão), uma página de status HTML é renderizada para o código de status retornado. Disponível para uso com o agente e o gateway de API versões 10.59 ou posteriores.

jitterbit.api.response.headers.*

Tipo de dados

Corda

Descrição

Usado para definir os cabeçalhos de resposta da API. Por exemplo, defina jitterbit.api.response.headers.access_control_allow_origin="*" para substituir o comportamento padrão do CORS e permitir que a API seja acessada por qualquer domínio de maneira entre sites.

jitterbit.api.response.status_code

Tipo de dados

Corda

Descrição

Fornece a capacidade de substituir o código de resposta HTTP para APIs personalizadas usando uma variável de script Jitterbit. Defina o jitterbit.api.response.status_code variável no script que é executado por uma API personalizada. Isso permite que autores de projeto definam um código de erro HTTP específico (junto com informações de payload reais) em vez de depender do sistema para retornar os códigos 200 ou 500 com base no comportamento padrão.