↗️Ficha Solicitudes externas

La pestaña de Solicitudes Externas es una pestaña donde puede crear y gestionar Solicitudes Externas que pueden utilizarse en los Agentes.

Navegar hasta la pestaña Solicitudes externas

Hay tres maneras de navegar a la pestaña de Solicitudes Externas:

1. Vaya a la pestaña Recursos y haga clic en el botón Solicitudes externas.

1. Vaya al Proyecto y abra la pestaña Solicitudes externas.

1. Vaya al Diseñador de Agentes y abra la pestaña Solicitudes Externas.

Lista de solicitudes externas

La pestaña Solicitudes externas muestra una lista de todas las solicitudes externas:

1. Nombre muestra el nombre de la solicitud externa.

⁠2. Botón de ordenación alfabética: al hacer clic en este botón se cambia el orden de clasificación de A-Z a Z-A y viceversa.

1. Método y URL: la URL de destino a la que debe enviarse la solicitud externa y el método HTTP de la solicitud externa.

1. En uso - indica si la Solicitud Externa está siendo utilizada en los Agentes.

a. Cada Solicitud Externa utilizada en los Agentes está marcada con una marca de verificación y un botón Aclarar.

b. Al hacer clic en el botón Aclarar se muestran los iconos de los Agentes que utilizan la Solicitud Externa.

Búsqueda de solicitudes externas

Búsqueda por nombre de solicitud

1. Para buscar solicitudes externas por nombre, introduzca el valor deseado en el campo de búsqueda.

2. La lista mostrará sólo las Solicitudes Externas que contengan la cadena de búsqueda en su nombre.

Búsqueda por solicitud Utilización

La búsqueda por uso de Solicitud Externa en los Agentes se realiza utilizando los filtros En uso y No en uso:

1. Al hacer clic en el botón En uso sólo se muestran las Solicitudes externas que se utilizan en los Agentes.

1. Al hacer clic en el botón En uso se sustituye el filtro No en uso por el filtro Agente: un filtro por Agentes.

   1. Al hacer clic en el botón Agente se abre el panel de búsqueda por Agentes.

b. Para encontrar Solicitudes Externas utilizadas en Agentes específicos, haga clic en los Agentes deseados de la lista.

1. Al hacer clic en el botón No en uso se muestran las Peticiones Externas que no se utilizan en los Agentes.

Crear, editar y eliminar solicitudes externas

Crear una solicitud externa

Para crear una nueva solicitud externa, siga estos pasos:

1. Vaya a la lista de Solicitudes Externas.

2. Haga clic en el botón Crear nuevo.

1. Al hacer clic en el botón se abrirá un formulario en el panel derecho para crear una nueva Solicitud Externa.

2. Rellene los campos de las pestañas del formulario para facilitar los datos necesarios para la solicitud externa.

Pestaña principal

La pestaña Principal contiene los datos básicos de la Solicitud Externa.

1. Nombre - el nombre de la Solicitud Externa. La longitud máxima del campo es de 1000 caracteres.

2. Descripción: descripción de la solicitud externa. La longitud máxima del campo es de 1000 caracteres.

3. Método - el método HTTP para la solicitud externa. El método por defecto es GET.

   1. GET

   2. POST

   3. PUT

   4. PATCH

   5. DELETE

   6. HEAD

4. Endpoint - la dirección webhook a la que debe enviarse la Solicitud Externa. La longitud máxima del campo es de 1000 caracteres.

   1. Formato del valor:

      1. Cadena

ii. Variable de contexto en el formato {{var}}

iii. Expresión o Expresión con Estructura de Control. Más detalles: Uso de sintaxis en solicitud externa.

Ficha Encabezados

En la pestaña Cabeceras, puede añadir cabeceras a la solicitud externa.

1. Cabecera - el nombre de la cabecera. La longitud máxima del campo es de 1000 caracteres.

2. Valor - el valor de la cabecera. La longitud máxima del campo es de 1000 caracteres.

   1. Formato del valor: texto plano, Variables Contextuales, Expresión o Expresión con Estructura de Control.

Ficha Parámetros de consulta

En la pestaña Parámetros de consulta, puede especificar los parámetros que se añadirán a la URL de la solicitud externa.

1. Parámetro - el nombre del parámetro. La longitud máxima del campo es de 1000 caracteres.

   1. Se pueden utilizar caracteres no latinos en el nombre del parámetro. El valor del parámetro se codificará cuando se envíe la solicitud externa.

2. Valor - el valor del parámetro.

   1. Formato del valor: texto plano, Variables Contextuales, Expresión o Expresión con Estructura de Control.

   2. Se pueden utilizar caracteres no latinos en el valor. El valor del parámetro se codificará cuando se envíe la solicitud externa.

Ficha Datos

En la pestaña Datos, puede especificar los datos en formato JSON o XML que se enviarán en el cuerpo de la solicitud externa.

1. Tipo de datos: el formato de los datos que se enviarán en el cuerpo de la solicitud externa.

   1. Formato por defecto: JSON

   2. Formatos:

      1. JSON

      2. XML

2. Datos - un campo para añadir la plantilla del cuerpo de la Solicitud Externa que se enviará. La longitud máxima del campo es de 1000 caracteres.

   1. Formato:

      1. Cuando el tipo de datos es JSON: texto arbitrario.

      2. Cuando el tipo de datos es XML: Sintaxis XML. El caso de la etiqueta es importante— <var></Var>se considerará una etiqueta no cerrada y la solicitud no se ejecutará

   2. Sustitución de Variables de Contexto, Expresión o Expresión con Estructura de Control:

      1. En la plantilla del cuerpo de la solicitud, puede especificar una Variable de Contexto con el formato {{ var }}, Expresión o Expresión con Estructura de Control, cuyos valores y resultados se sustituirán cuando se ejecute la solicitud. Más información: Uso de sintaxis en peticiones externas.

         1. Si la variable de contexto no se encuentra en el contexto del chat, se sustituirá por un valor vacío.

         2. Si se produce un error durante la evaluación de la Expresión o Expresión con Estructura de Control (por ejemplo, división por 0), no se enviará la Petición Externa y se crearán las siguientes Variables de Contexto en el Contexto del Chat:

            1. error = "Se ha producido un error en la representación de la plantilla (opciones de solicitud)."

            2. request_success = False

            3. response_status_code = 499

            4. raw_response = ""

   3. Formato de valor para la variable de contexto:

      1. Para Tipo de datos: JSON:

         a. El valor de una variable de texto se sustituye en la plantilla sin comillas. Si es necesario enviar un valor de texto en JSON, debe ir entre comillas — "{{ var }}".

         1. Por ejemplo, si la cadena '89222203909' se almacena en la variable {{ phone }} en el Script, entonces

         2. al ejecutar una solicitud con Datos= { "phone_num": {{ phone }} }, el cuerpo{ "phone_num": 89222203909 } se enviará.

         3. al ejecutar una solicitud con Datos = { "phone_num": "{{ phone }}" }, el cuerpo { "phone_num": "89222203909" } se enviará.

3. Para Tipo de datos: XML:

   1. La variable debe escribirse en una etiqueta XML utilizando llaves {{ }} y considerando el caso. Por ejemplo:

Ficha Respuesta

En la pestaña Respuesta, se configura el análisis sintáctico de las respuestas a una Solicitud Externa en Variables de Contexto de Usuario.

Cuando se analiza una respuesta a una petición, las variables especificadas en el campo Valor no son Variables de Contexto, sino referencias a los objetos body y headers (partes de la respuesta a la petición) y sus propiedades.

1. Tipo de datos - formato de los datos recibidos (BODY de Response)

   1. Formato por defecto: JSON

   2. Formatos:

      1. JSON

      2. XML

      3. TEXT

1. La parte tabular es un array de pares Variable - Valor para parsear datos del cuerpo y cabeceras de la respuesta a una Petición Externa en Variables de Contexto de Usuario para su uso en el Script.

a. Variable - el nombre de las variables de contexto de usuario en las que se escribirá el valor. La longitud máxima de un valor de campo es de 128 caracteres. El nombre de las variables de contexto de usuario debe cumplir los requisitos de denominación de las variables de contexto de usuario.

b. Valor - clave o ruta Xpath a la etiqueta xml del cuerpo de la respuesta o de las cabeceras, cuyo valor se escribirá en la Variable de Contexto. La longitud máxima de un valor de campo es de 1000 caracteres. Una vez alcanzado el valor máximo, no se introducirán más caracteres en el campo;

i. Es posible analizar el cuerpo y las cabeceras de la respuesta:

1. body. —a partir del cuerpo de la solicitud;

2. headers. — a partir de las cabeceras de las peticiones.

ii. Formato del valor: puede utilizar Expresión o Expresión con Estructura de Control.

Importante: el acceso a la clave de un objeto, si su nombre coincide con el nombre de los métodos Reservados de los objetos, se produce a través de corchetes y comillas. Ejemplo: {{ data["keys"] }}

Importante: se ha implementado una limitación en el tamaño del cuerpo recibido en respuesta a una petición externa: si el tamaño del cuerpo excede Limit on the size of the received body in response to an External Request , entonces se sustituye por un cuerpo vacío. {}.

Ejemplos de análisis sintáctico del cuerpo y las cabeceras de la respuesta en una variable de contexto:

• Ejemplo de un cuerpo JSON y su análisis en la configuración de la ranura:

{
          “par”: “value”,
          “content”:
              {
                  “par1”: “value1”,
              },
          “array”: [
              {
                  “par2”: “value2”,
              },
              {
                  “par3”: “value3”,
              }
          ]
      }

• Ejemplo de un cuerpo XML y su análisis en la configuración de la ranura:

• Ejemplo de un cuerpo de TEXTO y su análisis en la configuración de la ranura:

  • Para el tipo TEXTO, sólo se puede analizar el cuerpo completo.

Ficha Certificado

En la pestaña Certificado, puede especificar el certificado y su contraseña para las integraciones con sistemas informáticos externos cuyos métodos requieran la autorización mediante un certificado de cliente.Esta pestaña sólo está disponible para las solicitudes externas existentes. Esta pestaña no es accesible cuando se crea una nueva solicitud externa.

Campos y elementos:

1. Usar certificado: un conmutador para activar o desactivar el uso del certificado en la solicitud.

Importante: La edición de campos sólo es posible cuando el conmutador está apagado.

1. Passphrase — una frase secreta utilizada para acceder al certificado.

2. Certificate —un campo en el que debe cargar un archivo (certificado digital).

   1. Extensiones de archivo compatibles

      1. .pfx

      2. .pem

   2. Límite de tamaño de los certificados— 100 КБ

3. Replace File Button —sustituye el archivo cargado (certificado digital).

1. Delete File Button — elimina el archivo cargado (certificado digital).

Características y limitaciones del trabajo con certificados

Certificados Graphlogic trabaja con	Los certificados Graphlogic no funcionan con	Certificados con los que trabaja Graphlogic pero con limitaciones
Certificados SSL en formato .pem y .pfx	Otros formatos
Talla hasta 100 KB	Tamaño superior a 100 KB
Emitido por una autoridad pública de certificación
Certificados emitidos para nombres de dominio públicos y privados

Ficha Prueba

En la pestaña Prueba puede comprobar el funcionamiento de la Solicitud Externa.

Al crear una nueva Solicitud Externa, antes de rellenar los parámetros de la Solicitud Externa, no se rellena el campo cURL.

Al abrir una Solicitud Externa existente, cURL se genera automáticamente.

1. Refresh cURL — un botón que, al pulsarlo, actualiza la solicitud en el campo cURL de la pestaña Solicitud de acuerdo con la configuración de Solicitud Externa.

2. Test cURL —un botón que, al pulsarlo, envía la solicitud generada en el campo cURL al sistema externo.

3. Displaying the status of the request —la respuesta recibida tras enviar la solicitud. El color depende del tipo de estado recibido:

   1. Successful status: 200 OK — verde;

⁠b. Statuses with warnings: from 201 to 399 —amarillo.

⁠c. Errors: from 400 and above — rojo. ​

1. Request section — la sección contiene datos para probar la Solicitud Externa

   1. cURL — generado a partir de la configuración Solicitud cURL entrante.

   2. Update request from cURL — un botón que, al pulsarlo, actualiza los campos External Request from cURL.

      1. Al hacer clic en el botón, aparece una ventana modal de confirmación:

1. Para confirmar la acción, debe pulsar el botón SÍ. En este caso, se produce la validación cURL:

   1. Si no hay ningún Endpoint o una estructura cURL incorrecta, se mostrará un error de cURL no válido y una notificación emergente Could’t parse cURL, la configuración de la solicitud no se ha actualizado.

​

b. Si cURL es correcto, se actualizará la configuración de la Petición Externa: se borrarán los campos de las pestañas Cabeceras, Parámetros de consulta, Datos, y se insertará en ellos la nueva información de cURL. Por ejemplo, si hay encabezados en la Solicitud Externa, pero no hay encabezados en el campo cURL, cuando haga clic en Actualizar Solicitud desde cURL, los encabezados actuales de la Solicitud Externa se eliminarán y no aparecerá nada en su lugar.

1. Response section —la sección contiene la respuesta del sistema externo a la solicitud.

⁠a. Antes de pulsar el botón Probar cURL, la sección no está disponible para su apertura (ya que la solicitud de prueba no se ha enviado y aún no hay respuesta)

⁠b. Subsection Body —la subsección contiene el cuerpo de la respuesta a la solicitud;

c. Headers subsection — la subsección contiene las cabeceras de la respuesta a la solicitud;

d. Muestra el estado de la solicitud;

e. Tiempo transcurrido desde el envío de una solicitud hasta la recepción de una respuesta, en milisegundos;

f. Tamaño del cuerpo de la respuesta en bytes.

Utilizar la sintaxis en solicitud externa

En una Petición Externa, es permisible usar Expresión y Expresión con Estructura de Control en los campos Endpoint, Value en la pestaña Headers y Query parameters, Data, Name en la pestaña Response. Más detalles: Sintaxis.

IMPORTANTE: al analizar una respuesta, todas las variables del campo Valor utilizadas en la plantilla se buscan en la respuesta, y no en el Contexto del chat. Se accede al cuerpo de la respuesta a través de la variable body. A las cabeceras de la solicitud se accede a través de la variable headers variable. Por ejemplo, si la respuesta a la solicitud externa es un objeto JSON: {“one”: {“two”: [0, 1, 2]}}, entonces:

1. El objeto JSON completo (dictionary) {“one”: {“ two”: [1, 2, 3]}}se guardará en la variable resp_body;

2. El objeto (dictionary) {“two”: [1, 2, 3]} se guardará en el resp_one variable;

3. El número entero 1 se almacenará en el resp_two variable;

4. Enresp_invalid no se guardará porque se debe acceder al cuerpo de la respuesta a través de la variable body variable.

Editar una solicitud externa

Para editar una solicitud externa existente, siga estos pasos:

1. Vaya a la lista de Peticiones Externas.

2. Abra la configuración de la solicitud externa haciendo clic en su nombre en la lista.

3. Realice los cambios deseados en los detalles de la Solicitud Externa en las pestañas del formulario.

4. Guarde los cambios pulsando el botón Guardar.

Borrar una solicitud externa

Para eliminar una única solicitud externa, siga estos pasos:

1. Ir a la lista de solicitudes.

2. Select the External Requesthaciendo clic en su nombre o utilizando el selector.
3. Haga clic en el botón Borrar solicitud o Borrar.

1. Confirme la acción en la ventana modal haciendo clic en el botón BORRAR INTENCIÓN.

a. Si la solicitud eliminada se utiliza en Agentes, aparecerá una advertencia indicando que es necesario eliminarla primero de los Agentes.

Clonación de una solicitud externa

Para crear una copia de una sola solicitud, siga estos pasos:

1. Ir a la lista de solicitudes.

2. Seleccione la solicitud haciendo clic en su nombre o utilizando el selector.

3. Haga clic en el botón Duplicar solicitud o Duplicar.

1. Confirme la acción en la ventana modal haciendo clic en el botón SÍ, ESTOY SEGURO.

a. Al hacer clic en el botón SÍ, ESTOY SEGURO se creará una copia de la solicitud con el nombre CLONE.

Acciones masivas con solicitudes externas

La pestaña Solicitudes externas admite múltiples acciones de selección y masivas que pueden aplicarse a un grupo de solicitudes.

Selección múltiple

La selección múltiple de solicitudes puede realizarse de las siguientes maneras:

1. Marque manualmente las casillas situadas junto a las solicitudes deseadas.

1. Marque la casilla en el selector de selección masiva - esto seleccionará todas las solicitudes en la página.

1. Seleccione uno de los grupos de solicitudes. Al hacer clic en la flecha se abre una lista desplegable.

a. La lista desplegable le permite seleccionar los siguientes grupos de solicitudes haciendo clic sobre ellos:

i. All — todas las solicitudes.

ii. In use — sólo solicitudes utilizadas en Agentes.

iii. Not in use — sólo solicitudes no utilizadas en Agentes.

Desmarcar solicitudes

Para anular la selección de las solicitudes seleccionadas, utilice uno de los siguientes métodos:

1. Elimine las casillas de verificación manualmente.

2. Utilice la opción de anulación de la selección en el selector de selección de masa.

1. Seleccione Borrar selección en la lista desplegable.

Supresión masiva de solicitudes

Para eliminar varias solicitudes a la vez, siga estos pasos:

1. Seleccione varias solicitudes como se describe en la sección Selección múltiple.

2. Haga clic en el botón Eliminar solicitudes.

1. Confirme la acción en la ventana modal haciendo clic en el botón BORRAR SOLICITUDES.

1. Si alguna de las solicitudes seleccionadas se utiliza en Agentes, aparecerá una advertencia indicando que esas solicitudes no se eliminaron.

1. Las demás solicitudes se eliminarán.

Clonación masiva de solicitudes

Para clonar varias solicitudes a la vez, siga estos pasos:

1. Seleccione varias solicitudes como se describe en la sección.

2. Haga clic en el botón Duplicar solicitudes.

1. Confirme la acción en la ventana modal haciendo clic en el botón SÍ, ESTOY SEGURO.

1. Al hacer clic en el botón SÍ, ESTOY SEGURO, se crearán copias de las solicitudes con los nombres .CLONE.

Exportación-importación de solicitudes externas al exportar-importar Agente

Cuando se exporta una versión de un Agente, también se exportan todas las Solicitudes Externas contenidas en esta versión. Cuando se importa un Agente, se importan las Solicitudes Externas utilizadas en él, y:

1. Si la Empresa tiene una Solicitud Externa con un nombre y contenido idénticos, no se produce la duplicación de la Solicitud Externa. El Agente importado utilizará la Solicitud Externa ya existente. En los demás casos, se creará una nueva solicitud externa.

2. Si la Empresa tiene una Solicitud Externa con un nombre idéntico pero diferente contenido, se creará un duplicado de esta Solicitud Externa con un nombre generado automáticamente:

1. Plantilla para el nombre de la solicitud externa importada: request_name [import timestamp]., donde timestamp es la hora de importación de este Agente: el número de segundos transcurridos desde el 1 de enero de 1970.

2. Si la Compañía tiene una Solicitud Externa con un nombre diferente, pero idéntico contenido, entonces se importará la Solicitud Externa del archivo de configuración del Agente.

3. Si la empresa no dispone de una solicitud externa de este tipo, se importará y aparecerá en la lista de solicitudes externas.