Solicitud web - BETA

Utilice la etapa de Solicitud web para recuperar información que se utilizará dentro de un bot, o para impulsar cambios en un sistema externo. La etapa se ejecuta desde la Plataforma de Ivanti Neurons y se ejecuta una vez por cada dispositivo que pasa por la etapa. Puede interactuar con API REST de terceros y es compatible con API autenticadas y no autenticadas.

Cómo configurar la etapa de solicitud web

  1. En la página Crear bot, añada una etapa Solicitud Web a un bot y abra la configuración de la etapa.
  2. En el menú desplegable Seleccionar credencial, seleccione la credencial si la solicitud web requiere autenticación. Si necesita crear nuevas credenciales, haga clic en Agregar credenciales para abrir el Almacén de credenciales. Actualmente se admite la autenticación de API básica y de clave de API. Si no se necesitan credenciales, deje la configuración predeterminada Sin autenticación.
  3. En Encabezados ajuste Mostrar encabezados autogenerados como Activado si desea ver los encabezados autogenerados. Los encabezados están en línea con los requisitos de la API de destino, para más detalles consulte la documentación de terceros.
    • Clave: introduzca la clave del encabezado para la solicitud web.
    • Valor: introduzca el valor del encabezado para la solicitud web.
  4. Seleccione el método. Es el método HTTP que se utilizará para acceder a la API de destino. Los métodos admitidos son: GET, POST, PUT, PATCH y DELETE.
  5. Introduzca la Dirección de la API. La dirección debe ser accesible por Internet.
    Si está pasando valores desde otra etapa o entrada de bot, y la API de destino acepta una carga útil JSON, haga clic en Editar cuerpo de JSON para abrir el editor Json. Seleccione los valores que desee incluir (la etapa Solicitud Web debe estar conectada a las etapas anteriores para que se transmita la información).
  6. Elija el modo de salida adecuado para reflejar la respuesta de la API. Si ha seleccionado un método HTTP de GET más común será JSON.
  7. Haga clic en Probar y obtenga la respuesta para realizar una llamada inmediata a la API.
    Si el cuerpo de JSON contenía variables de etapas anteriores, se le pedirá que introduzca datos de ejemplo.
  8. El Ejemplo de respuesta se rellena desde la acción Probar y obtener respuesta.
    Una vez que haya verificado la respuesta, puede determinar si los resultados son singulares (campos únicos por endpoint) o una matriz (varios valores para un campo determinado por endpoint).
  9. Si los resultados son una matriz, es necesario activar la Matriz de asignación.
    Cuando la etapa está en el modo de matriz de asignación, la etapa mostrará la insignia "múltiple", lo que significa que para utilizar los resultados en la mayoría de las otras etapas deberá usar un bloque "For-each" para ejecutar el contenido de cada resultado.
    • Introduzca la ruta a la matriz.
  10. Una vez que la opción Matriz de asignación esté Activada, complete los siguientes atributos Asignación de campo:
    • Ruta dentro del elemento de la matriz: la ruta al objeto en la respuesta JSON. Puede tratarse simplemente del nombre, pero si el objeto está anidado, la ruta debe indicarse en sintaxis de puntos, por ejemplo.nivel1.nivel2.micampo
      Ejemplo singular:
      {"configuration": {startup_events": {"updates": "some value"}}}
      La ruta a las actualizaciones sería: configuration.startup_events.updates
      Ejemplo de matriz:
      {"users": [{display_info": {"name": "John"}}]}
      La ruta a la matriz sería: users
      La ruta dentro de la matriz sería: display_info.name
    • Tipo: debe coincidir con el formato del valor que se está leyendo para que se puedan aplicar los filtros/comportamientos correctos en etapas futuras.
    • Etiqueta asignada: este es el nombre descriptivo para el campo que se mostrará en el selector de tokens y filtros en etapas posteriores.

Una vez seleccionados los atributos de la matriz de asignación, haga clic en Probar asignación para probar las asignaciones en la Respuesta de ejemplo, esto asegura que las asignaciones sean correctas.