Gestionar flujos de trabajo de API

Crear flujos de trabajo de API

Para crear una solución de flujo de trabajo de API:

1. En tu organización de Automation Cloud™, abre Studio Web.
2. Select Create New > API Workflow. A new solution opens, with the API Workflow designer canvas displayed.

Definición de esquemas de entrada

Los flujos de trabajo de API funcionan como API y pueden requerir un esquema de entrada para definir los parámetros de entrada esperados. El esquema de entrada especifica la estructura de datos que debe proporcionar un servicio externo al desencadenar el flujo de trabajo.

Puedes configurar el esquema de entrada cargando un JSON o definiendo manualmente los parámetros de entrada.

1. En tu proyecto de flujo de trabajo de API, abre el panel Gestor de datos .
2. Selecciona la pestaña Entrada .

   Para cargar un esquema JSON, sigue el paso 3.

   Para definir manualmente los parámetros de entrada, sigue el paso 4.

3. Para cargar un esquema JSON con los parámetros de entrada ya definidos, selecciona Generar a partir de carga útil.
   1. Proporciona el JSON con la entrada esperada.
   2. Selecciona Generar esquema.
   3. Revisa el esquema generado y añade descripciones a las propiedades si es necesario.
4. Para definir manualmente los parámetros de entrada, selecciona Añadir propiedad.
   1. Configura los detalles de la propiedad:
      • Nombre : define la clave de propiedad
      • Tipo : selecciona entre Cadena, Número, Entero, Booleano, Objeto, Matriz, Fecha-hora, Fecha, Hora.
        Importante: Si utilizas un Objeto o una Matriz, define las propiedades de los elementos anidados.
      • Requerido : selecciona esta casilla para marcar la propiedad como necesaria.
   2. Repite el paso hasta que definas todos los parámetros de entrada.

Definición de esquemas de salida

El esquema de salida define la estructura de los datos devueltos por el flujo de trabajo de la API, garantizando que cualquier servicio que llame al flujo de trabajo comprenda el formato de salida de antemano. El esquema de salida puede incluir datos definidos explícitamente dentro del propio esquema, como ID o valores proporcionados por el usuario, así como salidas generadas dinámicamente a partir de pasos del flujo de trabajo, como respuestas de API o valores calculados.

Puedes configurar el esquema de salida cargando un JSON o definiendo manualmente los parámetros de salida.

1. En tu proyecto de flujo de trabajo de API, abre el panel Gestor de datos .
2. Selecciona la pestaña Salida .

   Para cargar un esquema JSON, sigue el paso 3.

   Para definir manualmente los parámetros de salida, sigue el paso 4.

3. Para cargar un esquema JSON con los parámetros de salida ya definidos, selecciona Generar a partir de carga útil.
   1. Proporciona el JSON con la salida esperada.
   2. Selecciona Generar esquema.
   3. Revisa el esquema generado y añade descripciones a las propiedades si es necesario.
4. Para definir manualmente los parámetros de salida, selecciona Añadir propiedad.
   1. Configura los detalles de la propiedad:
      • Nombre : define la clave de propiedad
      • Tipo : selecciona entre Cadena, Número, Entero, Booleano, Objeto, Matriz, Fecha-hora, Fecha, Hora.
        Importante: Si utilizas un Objeto o una Matriz, define las propiedades de los elementos anidados.
      • Requerido : selecciona esta casilla para marcar la propiedad como necesaria.
   2. Repite el paso hasta que definas todos los parámetros de salida.

Cómo utilizar el editor de expresiones

El editor de expresiones te ayuda a acceder, evaluar y manipular datos dentro de los flujos de trabajo de la API. Úsalo para crear lógica condicional, configurar campos de actividad o escribir actividades JavaScript.

Diseño del editor de expresiones

El diseño del editor de expresiones contiene los siguientes paneles:

Panel	Descripción
Entrada	El panel principal es el panel de entrada, donde escribes tus expresiones JavaScript o JQ. Este panel incluye un verificador de sintaxis integrado que identifica y resalta los errores en la sintaxis de tu expresión.
Generador de expresiones de Autopilot	Situado en la parte inferior del panel de entrada, el generador de expresiones de Autopilot te ayuda a crear expresiones de flujo de trabajo utilizando lenguaje natural, en lugar de escribir JavaScript. Autopilot comprende el contexto de tu flujo de trabajo y te permite hacer referencia a objetos y pasos de flujo de trabajo simplemente describiendo el resultado deseado.
Entrada de prueba de actividad	A la derecha del panel de código, el panel de entrada Prueba de actividad te permite revisar los datos de prueba generados a partir de ejecuciones de flujo de trabajo anteriores. Proporciona datos de muestra que puedes utilizar para crear y validar expresiones, e interactúa directamente con el panel de salida Expresión para garantizar que tus expresiones produzcan los resultados deseados.
Salida de expresión	El panel de salida Expresión muestra el resultado de tu expresión en función de los datos de los datos de entrada de la prueba de actividad . Esto te permite validar que tu expresión genera el resultado esperado. Si tu expresión tiene errores, la sección de salida Expresión resalta la expresión problemática y proporciona un mensaje de error correspondiente. El resultado se actualiza automáticamente cada vez que modificas la expresión en el panel de entrada.

Acceder a los datos mediante JavaScript

Hay dos puntos de acceso para los datos del flujo de trabajo:

• $workflowse refiere a la configuración del flujo de trabajo.
• $contextse refiere a la configuración a nivel de actividad.
• $input : se refiere a la configuración de la actividad ejecutada anteriormente.

Importante: Utiliza la pantalla de entrada Probar dentro del editor de expresiones para hacer referencia a las propiedades de los pasos al crear tus expresiones.

Puntos de acceso	Descripción	Cómo utilizar
$workflow.input	Almacena el esquema de solicitud y cualquier valor definido en la configuración de prueba.	Para acceder a los datos de configuración de prueba dentro del editor de expresiones, introduce la siguiente sintaxis y reemplaza {property_name} por la propiedad específica a la que quieres hacer referencia: $workflow.input.{property_name}
$context	Almacena los datos de entrada y salida para cada paso del flujo de trabajo. Para hacer referencia a estas propiedades en tus expresiones, primero ejecuta y prueba el flujo de trabajo. Esto genera entradas y salidas a nivel de paso visibles en la pantalla Probar entrada .	Para acceder a los datos de respuesta de salida de un paso específico, utiliza el siguiente patrón de sintaxis en el editor de expresiones y reemplaza {step_name} y {property_name} con tus nombres de paso y propiedad, respectivamente: $context.outputs.{step_name}.content.{property_name}
$input	Almacena los datos pasados directamente del paso anterior al paso actual. Usa $input para hacer referencia a las propiedades del paso anterior sin navegar por todo el $context.	Para acceder a las propiedades del paso anterior, utiliza la siguiente sintaxis y sustituye {property_name}por la propiedad a la que deseas hacer referencia: $input.{property_name}

Probar flujos de trabajo de la API

Para una integración exitosa del flujo de trabajo de la API, prueba tu flujo de trabajo temprano y con frecuencia. Las pruebas regulares te ayudan a identificar y resolver errores rápidamente. Características como IntelliSense, la finalización automática, Autopilot y la pantalla de entrada de la prueba de actividad dependen de los datos de prueba. Ejecuta el flujo de trabajo regularmente utilizando el botón Probar para generar estos datos.

Las pruebas garantizan:

• Tus asignaciones de datos entre los pasos del flujo de trabajo son correctas, lo que evita un comportamiento inesperado.
• Las solicitudes de API están configuradas correctamente, lo que garantiza respuestas fiables.
• Tu flujo de trabajo funciona según lo previsto, lo que reduce el riesgo de errores inesperados en la producción.

Comprender la información de salida de ejecución

El panel Ejecutar salida proporciona información detallada sobre la ejecución del flujo de trabajo.

Datos de entrada y salida de actividad

Estos datos están disponibles por actividad seleccionada y proporcionan:

• Datos de entrada:información que un paso recibe de la actividad anterior.
• Datos de salida:información producida por el paso actual, pasada a la siguiente actividad.

Revise los datos de entrada/salida para confirmar las asignaciones y transformaciones de datos precisas.

Información de solicitud de API

Cuando los flujos de trabajo interactúan con las API, verifica los siguientes detalles de la solicitud:

• Solicitar URL:confirma que los parámetros de URL dinámica se resuelven correctamente.
• Encabezados:asegúrate de que los encabezados de autenticación y tipo de contenido estén configurados correctamente.
• Parámetros de consulta:comprueba que los filtros y parámetros tienen el formato correcto.
• Contenido del cuerpo:valida que la estructura JSON coincida con los requisitos de la API.

Solicitudes de API correctas

Para solicitudes de API correctas, expanda cada paso para revisar:

• Detalles de la solicitud:URL, encabezados, parámetros de consulta y contenido del cuerpo.
• Detalles de la respuesta : código de estado, encabezados y contenido de la respuesta.
• Datos de salida:información generada por la llamada a la API para su uso en pasos posteriores del flujo de trabajo.

Depurar

Para identificar y depurar de forma eficiente los errores del flujo de trabajo, sigue estas directrices:

• Indicadores de error
  • Los pasos que encuentran errores muestran un icono de error.
  • Selecciona el paso para ver mensajes de error detallados y salidas.
• Pasos comunes de depuración
  • Validar solicitudes de API : garantiza que los detalles de la solicitud, como las URL, los encabezados, los parámetros y el contenido del cuerpo, coincidan con la documentación de la API.
  • Revisar mensajes de error : examina los mensajes de error en busca de pistas sobre errores de autenticación, cargas útiles incorrectas o errores de script.

Añadir una configuración de depuración

Puedes crear y probar tu flujo de trabajo de API de forma iterativa, validando cada paso a medida que añades nuevas actividades. Para ejecutar estas pruebas de forma efectiva, puedes definir datos de entrada específicos utilizando la característica de configuración de depuración . Esto te permite establecer una entrada JSON una vez y reutilizarla en todas las ejecuciones de prueba posteriores. Puedes acceder a los datos emulados a través del objeto $workflow.input durante la ejecución del flujo de trabajo.

Para añadir una configuración de depuración:

1. En la parte superior del lienzo del diseñador de flujo de trabajo de la API, abre el menú desplegable Depurar y luego selecciona Depurar configuración.
2. En la ventana que se abre, proporciona los datos de entrada de prueba en formato JSON.
3. Guarda tu configuración de prueba.
4. Una vez guardada, puedes acceder a la configuración de prueba en el editor de expresiones utilizando la referencia $workflow.input.{propertyname}. Además, la configuración de depuración también se muestra en el panel de entrada Prueba de actividad del editor de expresiones.

Depurar el flujo de trabajo de la API

Para depurar tu flujo de trabajo de API:

1. Abre tu flujo de trabajo de API. Asegúrate de que tu flujo de trabajo está completamente configurado y listo para ejecutarse.
2. Si tu flujo de trabajo depende de los datos de entrada, por ejemplo, de un sistema externo, define la configuración de depuración antes de la prueba. Esto garantiza que cada paso reciba los datos necesarios.
3. Depura tu flujo de trabajo. El botón Depurar se encuentra en la parte superior de la página. Selecciónelo para ejecutar el flujo de trabajo y ver los resultados en tiempo real.
4. Una vez que se inicia la depuración, el panel Ejecutar salida aparece en el lado derecho de la pantalla. Aquí, puedes ver el estado de ejecución de cada paso claramente marcado como exitoso, fallido o pendiente.

Flujos de trabajo de la API de publicación

Importante: Antes de publicar, prueba tu flujo de trabajo de API utilizando escenarios de éxito y error para confirmar que cada escenario se ejecuta correctamente.

Para publicar tu solución de flujo de trabajo de API:

1. En el lienzo del diseñador de flujo de trabajo de la API, selecciona Publicar.
2. Selecciona la ubicación donde debe publicarse tu flujo de trabajo de API:
   • Tu fuente de espacio de trabajo personal de Orchestrator
   • Su fuente de tenant de Orchestrator
3. Proporciona otros detalles importantes para tu flujo de trabajo de la API, como el registro de cambios y la versión.
4. Selecciona Publicar. Una notificación te informa de la publicación correcta de tu flujo de trabajo de la API.

Si publicaste en tu fuente de espacio de trabajo personal, el flujo de trabajo es visible en Orchestrator en Mi espacio de trabajo > Automatizaciones > Procesos. Los flujos de trabajo de API son identificables por el tipo API.

Si publicaste en tu fuente de tenant, el flujo de trabajo es visible en Orchestrator en Tenant > Soluciones. Los flujos de trabajo de API son identificables por el tipo API.

Implementar flujos de trabajo de API

Una vez que hayas publicado tu flujo de trabajo de API en la fuente de tu preferencia, debes implementar la solución.

Implementar flujos de trabajo de API desde tu fuente de espacio de trabajo personal

Publicar en tu espacio de trabajo personal prepara el flujo de trabajo de la API como un proceso en Orchestrator > Mi espacio de trabajo > Tu nombre de flujo de trabajo de la API en la subcarpeta > Automatizaciones > Procesos.

Importante: Se crea automáticamente una subcarpeta dedicada dentro de tu carpeta de espacio de trabajo personal.

Implementar flujos de trabajo de API desde tu fuente de tenant

Al publicar en tu tenant de Orchestrator, se carga el paquete de flujo de trabajo de la API en Orchestrator > Tenant > Soluciones.

Para implementarlo como proceso:

1. Ve a Orchestrator > Tenant > Soluciones.
2. Para el paquete de flujo de trabajo de API que publicaste anteriormente en tu fuente de tenant, selecciona el menú de tres puntos y luego selecciona Implementar paquete.
3. En el asistente Implementar versión de la solución , configura los siguientes detalles:
   1. Nombre de implementación : añade el nombre que se mostrará en todas las páginas que mencionan, enumeran o supervisan procesos. Si se deja vacío, se utiliza el nombre del paquete.
   2. Carpeta de destino : indica la carpeta que se utilizará como carpeta principal para la raíz de la solución. La solución no se implementa en la carpeta seleccionada, sino que se crea una nueva carpeta secundaria.
   3. Instalar como una nueva carpeta raíz en el tenant : selecciona esta casilla para instalar la solución como una nueva carpeta raíz en el tenant actual.
   4. Nombre de la carpeta raíz de la solución : cambia el nombre de la carpeta raíz.
4. Selecciona Revisar. Ahora puede guardar su solución como borrador o validarla y continuar.
5. Selecciona Implementar. Ahora puedes encontrar tu flujo de trabajo como proceso en la carpeta indicada en el paso 3 > Automatizaciones > Procesos. Puedes identificar un flujo de trabajo de API por el tipo de API.
6. Selecciona Activar implementación para finalizar la implementación de tu flujo de trabajo de API.

Mejores prácticas

• Defina esquemas de entrada y salida claros para que otros productos de UiPath puedan entender e interactuar con su flujo de trabajo.
• Aprovecha la rápida velocidad de ejecución de los flujos de trabajo de la API para probar las cargas útiles de entrada y salida durante el tiempo de diseño.
• Utiliza Autopilot para generar expresiones contextuales y código JavaScript.
• Valida las expresiones en el panel de salida del Editor de expresiones para detectar problemas de sintaxis o lógica antes del tiempo de ejecución.
• Interactúa con los datos de entrada y salida en el panel Ejecutar salida expandiendo, contrayendo o copiando valores en el portapapeles.
• Salga del flujo de trabajo antes de tiempo configurando una actividad de Respuesta, ya sea Éxito o Fallo.
• En las actividades de bucle , es decir, Para cada y Hacer mientras, utiliza $input en lugar de $context para acceder a la salida del objeto anterior.
• Utiliza la actividad HTTP para llamar a las API directamente cuando un conector no proporciona la funcionalidad necesaria. Elige entre la actividad HTTP nativa o la actividad Solicitud HTTP específica del conector.
• Proporciona tokens de autenticación en la propiedad Encabezados de la actividad HTTP :

  { 
      Authorization: "<my_token>",
      "Content-Type": "application/json"
  }

  Para la autenticación básica, utiliza:

  { Authorization: "Basic " + btoa("<username>:<pass>")}