Variáveis da API Jitterbit no Design Studio

Introdução

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

Variáveis que terminam com um asterisco (*) indicam que o asterisco deve ser substituído por outro valor, conforme descrito na documentação de cada variável com um asterisco (*).

Informacional

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

Tipo de dado

String

Descrição

Examina o payload/payloads enviados para a API. Observe que, para a maioria das APIs, você deve esperar apenas um payload simples e, como tal, jitterbit.api.request.body é a variável a ser utilizada (também conhecida como content-type:text/plain).

Se você espera que múltiplos payloads sejam enviados de uma só vez, utilizando o formulário codificado em URL (também conhecido como content-type:application/x-www-form-urlencoded), como no caso de uma API sendo usada como o 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.*. Assim como com jitterbit.api.request.parameters.*, jitterbit.api.request.body.name será igual a EStore se o valor do campo "name" do formulário foi inserido como EStore.

jitterbit.api.request.enum.body

Tipo de dado

String

Descrição

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

jitterbit.api.request.enum.headers

Tipo de dado

String

Descrição

Array variável usado para iterar dinamicamente por todos os cabeçalhos da solicitação (em vez de verificar cabeçalhos específicos como em jitterbit.api.request.headers.*). O uso é o mesmo que com jitterbit.api.request.enum.parameters e jitterbit.api.request.enum.body.

jitterbit.api.request.enum.mvparameters

Tipo de dado

String

Descrição

Array variável usado para iterar dinamicamente por todos os parâmetros de múltiplos valores (em oposição a verificar cada parâmetro especificamente como jitterbit.api.request.mvparameters.ProdID).

jitterbit.api.request.enum.parameters

Tipo de dado

String

Descrição

Array variável usado para iterar dinamicamente por todos os parâmetros enviados (em oposição a verificar 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 dado

String

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 acessando a URL.

Tanto cabeçalhos padrão em RFC 9110 quanto cabeçalhos personalizados são suportados. Para determinar quais chaves de cabeçalho estão sendo enviadas, consulte a documentação OpenAPI através das páginas do Portal da API e Gerenciador do Portal.

Examples

// Retorna o valor do cabeçalho Content-Type
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

// Retorna o valor do cabeçalho my-custom-key
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

Data type

String

Description

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

jitterbit.api.request.method

Data type

String

Description

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

jitterbit.api.request.mvparameters.*

Data type

String

Description

Examina os valores múltiplos do parâmetro enviado para a API diretamente via URL e retorna os valores como um array com um espaço entre cada valor.

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

jitterbit.api.request.parameters.*

Data type

String

Description

Examina os parâmetros enviados para a API diretamente via URL; por exemplo, jitterbit.api.request.parameters.name será igual a EStore se a URL solicitada tiver &name=EStore.

Configurações

jitterbit.api.response

Tipo de dado

String

Descrição

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

jitterbit.api.response.blank_error_response

Tipo de dado

Booleano

Descrição

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

jitterbit.api.response.enabled_null_support

Tipo de dado

Booleano

Valor padrão

false

Descrição

Defina como true antes de trabalhar com jitterbit.api.response para evitar a truncagem de valores nulos. Esta variável é suportada ao usar versões de agente 11.44 ou posteriores.

jitterbit.api.response.headers.*

Tipo de dado

String

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 de CORS e permitir que a API seja acessada por qualquer domínio de forma cross-site.

jitterbit.api.response.status_code

Tipo de dado

String

Descrição

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