API de Control Room

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

Importante:
  • Desde la versión v.33 de Automation 360, las API de autenticación: Los métodos POST v1/authentication y POST v1/authentication/token se suspendieron y dejarán de funcionar. Para garantizar un acceso ininterrumpido, actualice sus aplicaciones para utilizar las versiones v2 de las API de autenticación: PUBLICAR v2/authenticationy PUBLICAR v2/authentication/token.
  • A partir de la versión v.33 de Automation 360, las API de administración de usuarios serán las siguientes: v1/usermanagement está suspendido y dejará de funcionar. Para garantizar un acceso ininterrumpido, actualice sus aplicaciones para utilizar las versiones v2 de las API de administración de usuarios. v2/usermanagement.

Puede ver y navegar por todos los módulos de API de Control Room y los extremos asociados en la siguiente tabla de referencia de API:

Versión1 Punto final Descripción
v1 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 bots no supervisados o para filtrar usuarios por nombre.
API de automatizaciones Utilice las API del programador de bots (API de automatización) para crear, actualizar, eliminar y devolver detalles sobre las automatizaciones programadas.
API de activador Utilice las API de activador para crear y eliminar activadores de eventos. También puede asignar activadores a usuarios o roles para un Bot Runner asistido.
API de ejecución de tareas API Utilice las API de ejecución de tareas de API para generar una URL de ejecución de tareas de API junto con un token para iniciar una ejecución de tareas de API a través de un punto final de API.
v2 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.
v3 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) 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 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.
v4 API de implementación de bots (V4) Utilice la API de implementación de bots versión v4 para implementar bots desde el espacio de trabajo público a los dispositivos Bot Runner.
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.

1Las versiones de API 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.

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:Vea el siguiente video para aprender a probar la API del Control Room en Swagger y Postman: