Saltar al contenido

Variables de API Jitterbit en Design Studio

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 se leen (Informativas) y variables de configuración que se escriben (Configuración).

Las variables que terminan en un asterisco (*) indican que el asterisco debe ser reemplazado por otro valor, como se describe en la documentación de cada variable con un asterisco (*).

Nota

Para las variables de Jitterbit con un guion en su nombre, utiliza las funciones Get y Set para recuperar y establecer sus valores. Por ejemplo: Get('jitterbit.target.http.response.header.X-Jitterbit-Authorization').

Informativas

jitterbit.api.request.bodyy jitterbit.api.request.body.*

Tipo de dato

Cadena

Descripción

Mira la carga/payloads enviadas a la API. Ten en cuenta que para la mayoría de las APIs, se esperaría solo una carga simple y, como tal, jitterbit.api.request.body es la variable a utilizar (también conocida como content-type:text/plain).

Si esperas que se envíen múltiples cargas a la vez, utilizando el formulario codificado en URL (también conocido como content-type:application/x-www-form-urlencoded), como en el caso de una API que se utiliza como el backend de un formulario de envío (ver http://www.w3.org/TR/html401/interact/forms.html), entonces deberías estar utilizando 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 "name" del formulario se ingresó como EStore.

jitterbit.api.request.enum.body

Tipo de dato

Cadena

Descripción

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

jitterbit.api.request.enum.headers

Tipo de dato

Cadena

Descripción

Arreglo variable utilizado para iterar dinámicamente a través de todos los encabezados de la solicitud (en lugar de verificar encabezados específicos como con jitterbit.api.request.headers.*). El uso es el mismo que con jitterbit.api.request.enum.parameters y jitterbit.api.request.enum.body.

jitterbit.api.request.enum.mvparameters

Tipo de dato

Cadena

Descripción

Arreglo variable utilizado 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 dato

Cadena

Descripción

Arreglo variable utilizado 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 script de ejemplo agrega todos los parámetros proporcionados a una nueva variable para su posterior visualización 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 dato

Cadena

Descripción

Esta variable de Jitterbit devuelve el valor del encabezado especificado que se envía en la solicitud de API. El asterisco (*) debe ser reemplazado por la clave del encabezado.

Por ejemplo, la variable jitterbit.api.request.headers.x_forwarded_for devuelve la IP pública de la caja/usuario que accede a la URL.

Se admiten tanto encabezados estándar en RFC 9110 como encabezados personalizados. Para determinar qué claves de encabezado se están enviando, consulta la documentación de OpenAPI a través de las páginas del Portal de API y Administrador del Portal.

Importante

Si la clave del encabezado tiene un guion (-) en su nombre, debes usar la Get function para recuperar su valor. No hagas referencia a la variable usando un signo de dólar ($).

Examples

Nombre de clave de encabezado con un guion
// Devuelve el valor del encabezado Content-Type
Get('jitterbit.api.request.headers.Content-Type')
Nombre de clave de encabezado sin un guion
// 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
Nombre de clave de encabezado personalizado con un guion
// Devuelve el valor del encabezado my-custom-key
Get('jitterbit.api.request.headers.my-custom-key')
Nombre de clave de encabezado personalizado sin un guion
// 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

Cadena

Description

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

jitterbit.api.request.method

Data type

Cadena

Description

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

jitterbit.api.request.mvparameters.*

Data type

Cadena

Description

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

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

jitterbit.api.request.parameters.*

Data type

Cadena

Description

Mira los parámetros enviados a la API directamente a través de la URL; por ejemplo, jitterbit.api.request.parameters.name será igual a EStore si la URL solicitada tenía &amp;name=EStore.

Nota

Los parámetros de URL de múltiples valores devolverán una cadena delimitada por ||| (3 tuberías). Para devolver parámetros de URL de múltiples valores como un arreglo, utiliza la variable jitterbit.api.request.mvparameters.* en su lugar.

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

Configuración

jitterbit.api.response

Tipo de dato

Cadena

Descripción

Esta variable debe configurarse si tu API personalizada está configurada para usar una Variable del Sistema como el tipo de respuesta. La variable jitterbit.api.response puede usarse múltiples veces a lo largo de una cadena de operación, pero debe configurarse para cada uso.

Consejo

La variable jitterbit.api.response puede configurarse y usarse en un Variable endpoint para ser referenciada en la misma operación o en operaciones posteriores.

jitterbit.api.response.blank_error_response

Tipo de dato

Booleano

Descripción

Permite que se devuelva una respuesta API en blanco para códigos de estado que no sean de tipo 200 cuando jitterbit.api.response.blank_error_response está configurado como true. Cuando se configura como false (por defecto), se renderiza una página de estado HTML para el código de estado devuelto. Disponible para su uso con versiones de agente y API gateway 10.59 o posteriores.

jitterbit.api.response.enabled_null_support

Tipo de dato

Booleano

Valor por defecto

false

Descripción

Configúralo como true antes de trabajar con jitterbit.api.response para evitar la truncación de valores nulos. Esta variable es compatible cuando se utilizan versiones de agente 11.44 o posteriores.

jitterbit.api.response.headers.*

Tipo de dato

Cadena

Descripción

Se utiliza para establecer los encabezados de respuesta de la API. Por ejemplo, establece jitterbit.api.response.headers.access_control_allow_origin="*" para anular el comportamiento predeterminado de CORS y permitir que la API sea accesible desde cualquier dominio de manera cruzada.

jitterbit.api.response.status_code

Tipo de dato

Cadena

Descripción

Proporciona la capacidad de anular el código de respuesta HTTP para APIs personalizadas a través de la variable de script de Jitterbit. Establece la variable jitterbit.api.response.status_code en el script que se ejecuta por una API personalizada. Esto permite a los autores del proyecto establecer un código de error HTTP específico (junto con la información de carga útil real) en lugar de depender del sistema para devolver los códigos 200 o 500 según el comportamiento predeterminado.