API de Control Room

El Automation Anywhere de la Control Room proporciona varias API que lo habilitan a personalizar la forma en que usted (y sus automatizaciones) interactúan con Automation Anywhere.

Importante:
  • De Automation 360 v.34, los siguientes puntos finales de API de WLM están obsoletos y se planea discontinuarlos (EoL) junto con el lanzamiento de la versión 37:
    • POST /v3/wlm/workitemmodel
    • OBTENER /v3/wlm/workitemmodels/{id}
    • OBTENER /v3/wlm/queues/{id}
    • PUBLICAR /v3/wlm/queues/{id}/consumers
    • POST /v3/wlm/queues/{id}/participants
    • PONER /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PONER /v3/wlm/queues/{id}/workitems/{workItemId}
    Reemplace los puntos finales de API anteriores con los siguientes puntos finales de API:
    • POST /v4/wlm/workitemmodel
    • OBTENER /v4/wlm/workitemmodels/{id}
    • OBTENER /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • POST /v4/wlm/queues/{id}/participants
    • PONER /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PONER /v4/wlm/queues/{id}/workitems/{workItemId}
  • Desde Automation 360 v.34, los puntos finales de la API del Programador de bot: /v1/schedule/automations están obsoletos y se reemplazan por /v2/schedule/automations. Está previsto que la versión 1 se suspenda (EoL) junto con el lanzamiento de la v.38.

Puede ver y navegar por todos los módulos de API de la Control Room y los extremos asociados en las siguientes secciones de referencia de API.

Las diferentes versiones de API a continuación representan diferentes iteraciones de API a lo largo del tiempo. A medida que una API evoluciona, se introducen nuevas funciones o mejoras. Para gestionar estos cambios y mantener la compatibilidad con las aplicaciones existentes, los desarrolladores utilizan versiones.

Extremos de v1

Módulos Descripción
API de autenticación Utilice las API de autenticación versión v1 para verificar la autenticidad e integridad de los tokens web JSON (JWT), así como para finalizar sesiones de usuarios activas.
API de auditoría Utilice las API de auditoría para recuperar datos del registro de auditoría de su Control Room.
API del dispositivo Utilice las API del dispositivo para identificar todos los usuarios disponibles con licencias de Bot Runner no asistidas o para filtrar usuarios por nombre.
API de automatizaciones Obsoleto Utilice las API del programador de bots v1 (API de automatización) para crear, actualizar, eliminar y devolver detalles sobre las automatizaciones programadas.
API de activador Utilice las API de activación para mapear activadores a usuarios o roles para un usuario de Bot Runner asistido. También puede crear y eliminar activadores de eventos.
API de ejecución de tareas API Utilice las API de ejecución de tareas API para generar una URL de ejecución de tareas API junto con un token para iniciar una ejecución de tareas API a través de un extremo de API.
API de administración de políticas Utilice las API de administración de políticas para administrar el análisis de código, las políticas y las reglas dentro de la Control Room.
API de AI Agent Studio Utilice las API de AI Agent Studio para definir y conectarse a modelos de Conexiones del modelo personalizados. También puede recuperar y eliminar las Conexiones del modelo personalizadas.

Extremos de v2

Módulos Descripción
API de autenticación Utilice las API de autenticación versión v2 para generar y actualizar los Web Token JSON (JSON Web Tokens, JWT) requeridos para la autorización en todas las API de Enterprise Control Room.
API de administración de usuarios Utilice las API de administración de usuarios para ver y eliminar roles y usuarios en su Control Room.
API de Credential Vault Utilice las API de Credential Vault para crear, recuperar, actualizar y eliminar credenciales, valores de atributos de credenciales, casilleros y claves.
API de orquestación de ejecuciones de bot Utilice la API de orquestación de ejecuciones de bot versión v2 para monitorear dispositivos.
API de administración del repositorio Utilice las API de administración de repositorio para realizar tareas específicas en objetos (bots, carpetas y archivos) a los que tiene permiso de acceso en la Control Room.
API de BotInsight Utilice las API de Bot Insight para acceder en tiempo real a la información empresarial y a los datos de rendimiento de la fuerza de trabajo digital para utilizar los datos de productividad a nivel de contenido de las automatizaciones implementadas.
API de BLM Utilice las API de administración del ciclo de vida de los bots (BLM) para exportar e importar bots con archivos dependientes y paquetes de comandos para una gestión integral del ciclo de vida de la automatización.
Grupo de dispositivos API Utilice las API de grupos de dispositivos para crear, enumerar, actualizar y eliminar grupos de dispositivos.
API de licencia Utilice las API de licencia para recuperar los detalles de la licencia de la Control Room y sincronizarla manualmente con el servidor de licencias después de la reasignación o renovación de la licencia.
API del Process Composer Utilice las API de Processor Composer para crear una nueva solicitud a partir de procesos, recuperar el formulario inicial y solicitar por ID de referencia.
API de automatizaciones Utilice las API del programador de bots v2 (API de automatización) para crear, actualizar, eliminar y devolver detalles sobre las automatizaciones programadas.
API de administración de políticas Utilice las API de administración de políticas versión 2 para administrar el análisis de código, las políticas y las reglas dentro de la Control Room.

Extremos de v3

Módulos Descripción
API de implementación de bots Utilice la API de implementación de bots versión v3 para implementar bots desde el espacio de trabajo público a los dispositivos Bot Runner.
API de administración de la carga de trabajo Utilice las API de Administración de carga de trabajo (WLM) v3 para administrar y crear de manera programática modelos de elementos de trabajo, listas de prioridad, elementos de trabajo y automatizaciones en su Control Room.
API de migración (migración de bots) Utilice las API de migración versión v3 para migrar TaskBots y MetaBots que se crearon en las versiones de cliente Enterprise 11 y Enterprise 10 a Automation 360.
API de orquestación de ejecuciones de bot Utilice las API de orquestación de ejecuciones de bot v3 para monitorear el progreso de la actividad de automatización.

Extremos de v4

Módulos Descripción
API de implementación de bots (V4) Utilice la API de implementación de bots v4 para implementar bots desde el espacio de trabajo público a los dispositivos Bot Runner.
API de administración de la carga de trabajo Utilice las API de Administración de carga de trabajo (WLM) v4 para administrar y crear de manera programática modelos de elementos de trabajo, listas de prioridad, elementos de trabajo y automatizaciones en su Control Room.
API de migración (migración de bots) Utilice las API de migración versión v4 para migrar TaskBots y MetaBots que se crearon en las versiones de cliente Enterprise 11 y Enterprise 10 a Automation 360.
Nota: Para evitar errores y garantizar un procesamiento fluido de sus solicitudes, recuerde que todos los nombres de parámetros JSON distinguen entre mayúsculas y minúsculas. Para obtener más información, consulte las secciones relevantes de la documentación de referencia de API para obtener pautas y ejemplos claros que lo ayudarán a elaborar sus consultas y cuerpos de solicitud con la estructura correcta.

Cómo empezar con API para el Control Room

Todas las solicitudes deben incluir un encabezado X-Authorization con el token de autenticación JSON o un encabezado Autorización con un token Bearer para las solicitudes al Control Room. Las siguientes secciones proporcionan detalles sobre los puntos finales, métodos, recursos, protocolos de autenticación, parámetros y cabeceras disponibles de las API Control Room, así como ejemplos de solicitudes y respuestas comunes.

Nota: El token Bearer es compatible a partir de la versión Automation 360 v.27 y posteriores. No se admite y se ignora en todas las versiones anteriores. Debe obtener el token Bearer de nuestros servicios OAuth. Para autorizar su acceso, utilice X-Authorization (mediante la API de autenticación) o Autorización (mediante OAuth). No puede utilizar ambos en la misma API.
Puede utilizar la documentación de Swagger en Control Room para ver y ejecutar las API. Acceda a Swagger en Control Room mediante el enlace https://{control-room}/swagger/ y sustituya {control-room} por su instancia de Control Room. Las siguientes secciones proporcionan información útil sobre cómo escribir una solicitud de Control RoomAPI:

Política de obsolescencia de API

La obsolescencia de una API indica que ya no se recomienda su uso, pero es funcional. Se recomienda a los desarrolladores migrar a versiones más nuevas y compatibles de la API. La API estará disponible hasta la fecha de fin de vida útil (EoL) y la versión de lanzamiento para permitir una transición sin problemas.

API EoL indica la fecha y la versión de lanzamiento en la que la API dejará de funcionar y ya no estará disponible para su uso. Los desarrolladores deberían haber completado su migración a las versiones más nuevas y compatibles de la API antes de esta fecha.

Se podría requerir la eliminación de API en los siguientes escenarios:

  • Vulnerabilidades de seguridad: Las versiones anteriores de la API contienen vulnerabilidades de seguridad conocidas que se corrigieron en versiones más recientes.
  • Deuda técnica: Las versiones más antiguas de la API pueden estar construidas sobre tecnologías, enfoques o marcos obsoletos que ya no son compatibles, lo que dificulta el mantenimiento o las mejoras.
  • Rendimiento: Las versiones más antiguas de la API no están optimizadas para los casos de uso modernos ni aumentos de escala, lo que conduce a un rendimiento deficiente y tiempos de respuesta más lentos.
  • Experiencia de usuario: Las versiones obsoletas de la API contienen puntos finales confusos o redundantes que pueden dificultar la navegación por parte de los usuarios.

Las API serán compatibles durante un periodo mínimo de 2 años. Después de 2 años, se puede anunciar la obsolescencia de una API y estará disponible por al menos un año más (cuatro versiones) para brindarle suficiente tiempo para migrar a la versión más reciente.

Nota: La política anterior no se aplicará a la obsolescencia debido a vulnerabilidades de seguridad en las API públicas. En estos casos, se requiere una acción inmediata para mitigar riesgos y haremos todo lo posible para comunicarle este cambio lo antes posible.