Variáveis jitterbit da API

Introdução

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

Variáveis que terminam com um asterisco (*) devem significar 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

Analisa a payload/cargas submetidas à API. Observe que, para a maioria das APIs, você esperaria apenas uma 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 sejam enviadas de uma só vez, usando 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 back-end de um formulário de envio (consulte 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 variável usada para iterar dinamicamente por todas as partes enviadas da payload/corpo (em vez de verificar uma parte específica como acontece 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 variável usada para iterar dinamicamente por todos os cabeçalhos de solicitação (em vez de verificar um cabeçalho específico como acontece 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 amostra 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

Variável usada para ver os cabeçalhos das solicitações enviadas à API; por exemplo, $jitterbit.api.request.headers.x_forwarded_for é o IP público da caixa/usuário que acessa a URL.

jitterbit.api.request.headers.fulluri

Tipo de Dados

Corda

Descrição

O URL que foi chamado para acionar o Jitterbit OData ou API personalizada.

jitterbit.api.request.method

Tipo de Dados

Corda

Descrição

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

jitterbit.api.request.mvparameters.*

Tipo de Dados

Corda

Descrição

Observa 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

Consulta os parâmetros submetidos à API diretamente pela URL; por exemplo, jitterbit.api.request.parameters.nameserá igual a EStore se o URL solicitado 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 diversas 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

Boleano

Descrição

Permite que uma resposta de API em branco seja retornada para usuários não200-digite códigos de status quando jitterbit.api.response.blank_error_response está configurado 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 agente e 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 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. Colocou o jitterbit.api.response.status_code variável no script que é executado por uma API personalizada. Isso permite que os autores do projeto definam um código de erro HTTP específico (juntamente com as informações reais da payload) em vez de depender do sistema para retornar os códigos 200 ou 500 com base no comportamento padrão.