Saltar a contenido

JsonRequestFromPostmanFile

Nombre del elemento: JsonRequestFromPostmanFile (Solicitud web Json desde archivo postman)

Categoría: Módulo de acción

Descripción: funcionalidad básica, permite identificación de nombre y selección de verbos http. Orientada al consumo de servicios REST API externos y recibe estructuras Json como respuesta, utiliza estructura de importación extraída de Postman para configurar parámetros de llamada.

Funcionalidad: Permite la llamada de servicios web externos para su consulta, la configuraciones provienen de un archivo de importación extraído de Postman en el cual se delegan todas las configuraciones necesarias para la llamada, esta estructura puede ser modificada para albergar expresiones de texto e incluir entidades, sin embargo esta acción está pensada para llamadas que no requieran grandes cambios en parámetros de entrada, el resultado de la invocación es almacenado en una entidad de tipo string indicada por el usuario.

Es importante tener en cuenta lo siguiente:

  • Debe tener en cuenta que existen límites en la carga y manejo de grandes volúmenes de datos provenientes del API, ejemplo: imágenes serializadas o multimedia en formatos de bajo nivel, estos límites pueden variar en función de la disponibilidad de recursos de la plataforma, de tener alguna consulta con archivos de alta resolución y su serialización consulte a nuestro equipo.

  • Debe tener en cuenta que Tiempos de desborde muy altos (TO) se traducirán en lentitud de respuesta en las interacciones de Chat.

  • Para esta funcionalidad se requiere el uso del programa Postman con la capacidad de exportar colecciones, de allí se tomarán las estructuras requeridas para la configuración en esta caja de acción.

Campos de configuración de acción de JsonRequestFromPostmanFile

[Nombre] Descriptor único de caja de configuración con fines de identificar la misma en el flujo.

Subconjunto General

[Modo de Invocación] Define el modo de trabajo de la tecnología de comunicación implementada para la gestión de solicitudes salientes. (JREQUEST_INVOCATION_MODE)

Modos:

  • Normal (Defecto)

  • RelayWorker (Solo para integraciones con componente RelayWorker declarados)(Funciones Avanzada)

[Extracto de Postman Json] Este campo se usa para ingresar el extracto Postman que representa la solicitud saliente, el campo admite Expresión de texto por lo que podrá manipular los parámetros al ingresar el mismo como una expresión. (JSON_REQUEST_EXPRESSION)

-- Ejemplo de extracción desde Postman Collection:

Seleccione en Postman la colección objetivo que contenga la llamada al servicio de interés, y presione opciones de colección y a continuación exportar, guarde el archivo localmente y abra su contenido en un editor de texto. Obtendrá una estructura similar a:

{  
    info: 
    {  
        _postman_id: 8b87921f-63c3-4cbf-b86c-8e7412e3cbbe,  
        name: TOEXPORT,  
        schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json,  
        _exporter_id: 3438743  
    },  
    item: 
    [  
        {  
            name: EXPORTS FROM POSTMAN,  
            item: 
                [  
                    {  
                        name: http://worldtimeapi.org/api/timezone/America/lima,  
                        request: 
                        {  
                            method: GET,  
                            header: [],  
                            url: 
                            {  
                                raw: http://worldtimeapi.org/api/timezone/America/lima,  
                                protocol: http,  
                                host: 
                                [  
                                    worldtimeapi,  
                                    org  
                                ],  
                                path: 
                                [  
                                    api,  
                                    timezone,  
                                    America,  
                                    lima  
                                ]  
                            }  
                        }, 
                        response: []  
                    } 
                ]  
        }  
    ] 
}

Observe dentro de la estructura de la colección la sección “name” que corresponde a la carpeta que contiene la llamada y el contenido de esta listada en un arreglo “item”, dentro de dicho arreglo podrá reconocer los parámetros de cada llamada individualizados, segregue y copie la estructura correspondiente a la llamada de interés como se muestra a continuación.

{  
    name: http://worldtimeapi.org/api/timezone/America/lima,  
    request:
    {  
        method: GET,  
        header: [],  
        url: 
        {  
            raw: http://worldtimeapi.org/api/timezone/America/lima,  
            protocol: http,  
            host: 
            [  
                worldtimeapi,  
                org  
            ],  
            path: 
            [ 
                api,  
                timezone,  
                America, 
                lima  
            ]  
        }  
    }, 
    response: [] 
}

Esta será la estructura que se incluirá dentro de la expresión de texto del campo “Extracto de Postman Json”.

[Tiempo máximo de espera] El campo de tiempo máximo de espera (TO) se define por una expresión de texto que permite configurar en milisegundos cuanto tiempo debe esperar Lynn a la respuesta del servicio antes de que se considere la ausencia de respuesta un error de manejo. Este campo por defecto está configurado en 100 segundos, lo que corresponde con su mayor valor de configuración. Es recomendable que establezca el valor acorde a las buenas prácticas y promedios de respuesta de su servicio. (TIMEOUT_EXPRESSION)

[Resultado de consulta] Este campo aloja una expresión de texto que define la entidad que albergará la respuesta cedida del servicio externo consultado, recuerde que al tratarse de una expresión la definición de la entidad debe estar expresada como un literal entre comillas simples.(OUTPUT_RESULT_ENTITY)

[Manejador de errores] Caja de selección donde se identifica la intención que se activara en caso de presentarse un error en Json Request from Postman. Al ejecutarse un desborde de error la entidad Json_Request_From_Postman_Error será cargada con el detalle de error si el mismo se encuentra disponible. (INTENT_TO_EXECUTE_ON_ERROR)

Ejemplo de implementación JsonRequestFromPostmanFile

Ejemplo 1: Consultando la hora de mi ciudad

-- Entradas de datos:

Extracto de Postman Json:

{  
    request: 
    {  
        method: GET,  
        header: [],  
        url: 
        {  
            raw: http://worldtimeapi.org/api/timezone/'+ REGION +'/' +CITY + ',  
            protocol: http,  
            host: [ worldtimeapi,  org],  
            path: [  api,  timezone,  '+ REGION +',  ' +CITY + '  ]  
        } 
    },  
    response: [] 
}



    (Observe la inclusión de entidades en la estructura)

Tiempo máximo de espera: 1000

Resultado de consulta: 'JsonWebRequestResult'

Resultado 1 obtenido en la entidad a definir en “Resultado de consulta”.

Precondición: REGION -> America ; CITY -> Santiago

Importante: Use la acción JPath para recuperar valores de la estructura Json a entidades o si se siente más cómodo o son varios campos de interés también puede usar la acción Code Block para esta misma acción.

Precondición: REGION -> America ; CITY -> Lima

{
    abbreviation:-03,
    client_ip:20.201.25.83,
    datetime:2022-09-06T12:08:00.728505-03:00,
    day_of_week:2,
    day_of_year:249,
    dst:true,
    dst_from:2022-09-04T04:00:00+00:00,
    dst_offset:3600,
    dst_until:2023-04-02T03:00:00+00:00,
    raw_offset:-14400,
    timezone:America/Santiago,
    unixtime:1662476880,
    utc_datetime:2022-09-06T15:08:00.728505+00:00,
    utc_offset:-03:00,
    week_number:36
}

Funciones Avanzadas

Modo RelayWorker: Esta destinado a integraciones con la tecnología MS Relay para conseguir conexiones más estables y privadas en casos de integraciones contra infra estructuras que se encuentran en redes privadas.

Campos de configuración de acción

Subconjunto Relay Worker

Los campos de configuración de este sub-Conjunto están asociados a la conexión Relay, es probable que adicionalmente debe establecer algunas configuraciones adicionales en las políticas de seguridad de su firewall y la instalación de cliente Relay AZ y sus respectivos componentes, consulte a nuestro representante comercial si desea saber más sobre las características de dichos elementos.

[URL] URL de conexión a enlace Relay

[Conexión Hibrida] Nombre que define el contexto del enlace Relay.

[Nombre de clave de políticas de acceso] Nombre de identificador del conjunto de políticas de acceso.

[Valor de clave principal] Nombre de la clave de conexión.