Introducción a la API de Automation Hub

La característica Open API permite a los usuarios de UiPath Automation Hub acceder y manipular sus datos de tenant mediante programación. En función de los comentarios recibidos, así como de la estructura de la plataforma, nos hemos centrado en entregar solicitudes de API como en los siguientes ejemplos:

Nota:

• La lista completa de llamadas a la API se puede encontrar en la documentación de Swagger y Postman .
• Puedes encontrar algunos ejemplos rápidos sobre cómo utilizar las llamadas a la API en Ejemplos de llamadas a la API. Para una experiencia en profundidad o para probar respuestas de API específicas, utiliza el entorno Swagger o Postman descrito en Referencias de API.

Evaluaciones personalizadas

• GET/idea-schema
• POST/idea-from-schema
• GET/automations/{automationId}/schema
• PATCH/automations/{automationId}

Ideas de automatización

• GET/automations
• GET/automations/collaborators
• DELETE/automations/{automationId}/collaborators
• POST/automations/{automationId}/collaborators
• GET/automations/{automationId}/documents
• POST/automations/{automationId}/documents
• GET/automations/{automationId}/components
• GET/questionnaire
• GET/cba
• PUT/automations/cba/{automationId}/project-plan-baseline
• POST/automationidea
• POST/coe-automationidea
• POST/processmining-idea
• POST/automations/{automationId}/media
• POST/automations/status
• POST/automations/{automationId}/tags
• PUT/automation/{automationId}/categories

Nota:

Los puntos finales POST /automationidea, POST /coe-automationidea y POST /processmining-idea son puntos finales heredados que solo se pueden utilizar cuando las evaluaciones del flujo de ideas y los flujos de trabajo no se han personalizado. Para todas las nuevas integraciones y flujos de ideas personalizados, el enfoque recomendado es utilizar GET /idea-schema para recuperar la estructura del formulario de envío, seguido de POST /idea-from-schema para enviar la idea.

Proceso de automatización

• GET/automationpipeline

Usuarios

• GET/users
• GET/roles
• POST/adduser
• POST/edituser

Inventario de aplicaciones

• GET/appinventory
• PUT/appinventory
• DELETE/appinventory/{applicationId}

Categorías

• GET/hierarchy
• PUT/categories

Componentes

• GET/components

Automation Store

• GET/automation-store
• GET/automation-store/{automationId}/reviews

Las llamadas a la API reflejan las acciones que un usuario puede realizar en la interfaz de Automation Hub.

Para empezar a realizar llamadas con las siguientes variables, accede a las opciones de OpenAPI desde la plataforma de Automation Hub > Consola de administración > Configuración de la plataforma > Open API y genera tu token.

Variable	Valor
Token	El token generado desde la interfaz de usuario de Automation Hub.
URL	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
URL de versión retrasada	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
GET todas las ideas Estructura API para organizaciones de versión retrasada	https:///{orgName}/{tenantName}/automationhub_/api/v1/openapi
Clave de aplicación	La clave de la aplicación generada desde la interfaz de usuario de Automation Hub.

Nota:

{orgName} y {tenantName} son variables que se refieren al nombre de tu organización y al nombre de tu tenant.

El siguiente paso es Consumir las API disponibles.

Referencias de API

Se puede acceder directamente a la definición de Swagger de la API de Automation Hub añadiendo los detalles de autenticación en la clave de autorización en la llamada de solicitud denominada Encabezado.

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

La presente guía está creada para dar soporte a la documentación de Swagger, proporcionando ejemplos relevantes y fáciles de seguir.

Para usar la documentación de Swagger en organizaciones de versión retrasada, utiliza el siguiente enlace:

https://<accessURL>/{orgName}/{tenantName}/automationhub_/api/v1/api-doc/

Si prefieres trabajar con Postman, crea un entorno de Postman. Después, consulta nuestra colección de API disponible en Postman. La colección puede importarse haciendo clic en el botón Ejecutar en Postman .