Variables 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 puede leer (Informativo) y las variables de configuración que escriba (Configuración).

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

Informativo

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

Tipo de datos

Cadena

Descripción

Observa la carga útil o las 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.body es 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 formato 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 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 encabezados específicos 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 mostrarlos 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

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

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

Ambos encabezados estándar en RFC 9110 y se admiten encabezados personalizados. Para determinar qué claves de encabezado se están enviando, consulte la documentación de OpenAPI a través del API Manager Portal y Administrador del portal páginas.

Ejemplos

// 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 datos

Cadena

Descripción

La URL 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

Observa 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

Observa 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 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 debe configurarse para cada uso.

jitterbit.api.response.blank_error_response

Tipo de datos

Booleano

Descripción

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

jitterbit.api.response.headers.*

Tipo de datos

Cadena

Descripción

Se utiliza para configurar los encabezados de respuesta de la API. Por ejemplo, set jitterbit.api.response.headers.access_control_allow_origin="*" para anular el comportamiento CORS predeterminado y permitir que cualquier dominio acceda a la API desde varios 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 a través de la variable de secuencia de comandos Jitterbit. jitterbit.api.response.status_code Variable en el secuencia de comandos que se ejecuta mediante una API personalizada. Esto permite a los autores de proyectos 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 que devuelva los códigos 200 o 500 según el comportamiento predeterminado.