Variables de Jitterbit API

Introducción

Esta página cubre las variables de Jitterbit que están disponibles para las APIs personalizadas de Jitterbit, organizadas por variables informativas que lee (Informativo) y las variables de configuración que escriba (Configuración).

Las variables que terminan en un asterisco (*) indican que el asterisco debe reemplazarse con un nombre de encabezado, como en jitterbit.target.http.response.header.X-Jitterbit-Authorization.

Para obtener información detallada sobre el uso de las APIs personalizadas de Jitterbit, consulte API Manager.

Informativo

jitterbit.api.request.body y jitterbit.api.request.body.*

Tipo de Datos

Cadena

Descripción

Mira la carga/cargas útiles enviadas a la API. Tenga en cuenta que para la mayoría de las APIs, esperaría solo una carga útil simple y, como tal, jitterbit.api.request.bodyes la variable a utilizar (también conocida como content-type:text/plain).

Si espera que se envíen varias cargas útiles a la vez, utilice el formulario codificado en URL(también conocido como content-type:application/x-www-form-urlencoded), como en el caso de que se utilice una API como backend de un formulario de envío (consulte http://www.w3.org/TR/html401/interact/forms.html ), entonces debería utilizar jitterbit.api.request.body.*. Al igual que con jitterbit.api.request.parameters.*, jitterbit.api.request.body.name será igual a EStore si el valor del campo "nombre" del formulario se ingresó como EStore.

jitterbit.api.request.enum.body

Tipo de Datos

Cadena

Descripción

Matriz de variables utilizada para iterar dinámicamente a través de todas las partes enviadas de la carga útil/cuerpo (en lugar de verificar una parte específica como con jitterbit.api.request.body.*). El uso es el mismo que con el jitterbit.api.request.enum.parameters.

jitterbit.api.request.enum.headers

Tipo de Datos

Cadena

Descripción

Matriz de variables utilizada para iterar dinámicamente a través de todos los encabezados de solicitud (en lugar de verificar un encabezado específico como con jitterbit.api.request.headers.*). El uso es el mismo que con el jitterbit.api.request.enum.parameters y jitterbit.api.request.enum.body.

jitterbit.api.request.enum.mvparameters

Tipo de Datos

Cadena

Descripción

Matriz de variables utilizada para iterar dinámicamente a través de todos los parámetros de múltiples valores (en lugar de verificar cada parámetro específicamente como jitterbit.api.request.mvparameters.ProdID).

jitterbit.api.request.enum.parameters

Tipo de Datos

Cadena

Descripción

Matriz de variables utilizada para iterar dinámicamente a través de todos los parámetros enviados (en lugar de verificar cada parámetro específicamente como jitterbit.api.request.parameters.name).

Este secuencia de comandos de muestra agrega todos los parámetros proporcionados a una nueva variable para mostrarla más tarde al usuario:

<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 Datos

Cadena

Descripción

Variable utilizada para ver los encabezados de solicitud enviados a la API; Por ejemplo, $jitterbit.api.request.headers.x_forwarded_for es la IP pública del buzón/usuario que accede a la URL.

jitterbit.api.request.headers.fulluri

Tipo de Datos

Cadena

Descripción

La URL a la que se llamó para activar Jitterbit OData o API personalizada.

jitterbit.api.request.method

Tipo de Datos

Cadena

Descripción

El método de solicitud que se utilizó para llamar a la API.

jitterbit.api.request.mvparameters.*

Tipo de Datos

Cadena

Descripción

Mira los valores múltiples del parámetro enviado a la API directamente a través de la URL y devuelve los valores como una matriz con un espacio entre cada valor.

Por ejemplo, si la URL es https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, entonces jitterbit.api.request.mvparameters.ProdID será abc abc1 abc2.

jitterbit.api.request.parameters.*

Tipo de Datos

Cadena

Descripción

Mira los parámetros enviados a la API directamente a través de la URL; Por ejemplo, jitterbit.api.request.parameters.nameserá igual a EStore si la URL solicitada tuviera &name=EStore.

Ajustes

jitterbit.api.response

Tipo de Datos

Cadena

Descripción

Esta variable debe configurarse si su API personalizada está configurado para utilizar una Variable del sistema como tipo de respuesta. El jitterbit.api.response la variable se puede utilizar varias veces a lo largo de una cadena de operación, pero se debe configurar para cada uso.

jitterbit.api.response.blank_error_response

Tipo de Datos

Booleano

Descripción

Permite que se devuelva una respuesta API en blanco para no200-tipo códigos de estado cuando jitterbit.api.response.blank_error_response se establece en true cuando se establece en false (predeterminado), se representa una página de estado HTML para el código de estado devuelto. Disponible para usar con el agente y la puerta de enlace API versiones 10.59 o posteriores.

jitterbit.api.response.headers.*

Tipo de Datos

Cadena

Descripción

Se utiliza para configurar los encabezados de respuesta de la API. Por ejemplo, establezca jitterbit.api.response.headers.access_control_allow_origin="*" para anular el comportamiento predeterminado de CORS y permitir que cualquier dominio acceda a la API entre sitios.

jitterbit.api.response.status_code

Tipo de Datos

Cadena

Descripción

Proporciona la capacidad de anular el código de respuesta HTTP para APIs personalizadas mediante una variable de secuencia de comandos Jitterbit. Selecciona el jitterbit.api.response.status_code variable en el secuencia de comandos que ejecuta una API personalizada. Esto permite a los autores de proyectos establecer un código de error HTTP específico (junto con información de carga útil real) en lugar de confiar en que el sistema devuelva los códigos 200 o 500 según el comportamiento predeterminado.