Acceso a la API

Llama a la API de Integration Service desde una aplicación externa, utilizando la autorización OAuth 2.0 y los ámbitos de Integration Service.

Información general

La API de Integration Service te permite trabajar con recursos de Integration Service desde una aplicación externa de tu elección. Autorizas la aplicación a través del marco OAuth 2.0, por lo que un servicio o script puede autenticarse por sí mismo en lugar de depender de una sesión de usuario que haya iniciado sesión y sin compartir ninguna credencial.

Úsalo para llamar a Integration Service desde un proceso de CI/CD que publica o implementa una solución que hace referencia a un conector personalizado, o desde una aplicación codificada o agente que necesita crear o gestionar sus propias conexiones de Integration Service sin un usuario que haya iniciado sesión.

El acceso se limita a los ámbitos que concedes. Una aplicación externa, o un usuario que actúe a través de una, no puede superar esos permisos. El acceso a la API existente utilizando tokens de usuario no ha cambiado.

Descubre cómo registrar una aplicación externa.

Permisos de API

Para llamar a la API de Integration Service, debes conceder permisos de API a la aplicación externa. Estos permisos se conocen como ámbitos. Agrégalos en Automation Cloud en Admin > Aplicaciones externas, añadiendo Integration Service como recurso.

Ámbito	Concesiones	Disponible como
ES.Conexiones.Leer	Acceso de lectura a las conexiones.	Ámbito de usuario
ES.Conectores.Leer	Acceso de lectura a los conectores, incluida la descarga de un conector personalizado.	Ámbito de usuario, ámbito de aplicación
ES.Conector.Exportar	No utilizado. Ningún punto final requiere este ámbito.	N/D

Importante:

IS.Connections.Read es solo un ámbito de usuario. No se puede conceder una aplicación externa que se autentique por sí misma, sin un usuario que haya iniciado sesión.

Las aplicaciones no confidenciales solo pueden recibir ámbitos de usuario. Para conocer la diferencia entre los tipos de aplicación y entre los ámbitos de usuario y aplicación, consulta Autorizar aplicaciones externas.

Autorizar las llamadas a API

Autoriza tu aplicación externa creando un token de acceso para ella. Utiliza el ID de aplicación y el Secreto de aplicación generados al registrar la aplicación. El método de autorización depende del tipo de aplicación, confidencial o no confidencial.

Más información sobre los métodos de autorización para aplicaciones externas.

Envía el token como token al portador en tus solicitudes. Un token es válido durante una hora. Para seguir llamando a la API después de eso, genera un nuevo token de acceso o solicita un token de actualización.

Ámbito de la carpeta

Una aplicación externa debe dirigirse a una sola carpeta en cada solicitud, utilizando el encabezado X-UIPATH-FolderKey , y necesita el permiso Connections.View en esa carpeta. Se rechazan las solicitudes que omiten el encabezado y las solicitudes que solicitan todas las carpetas.

Una conexión que existe en una carpeta diferente de la que seleccionaste se informa como no encontrada, en lugar de prohibida.

Puntos finales disponibles

La guía de la API documenta actualmente estos puntos finales:

• Obtener conexiones
• Obtener conexión por ID
• Descargar conector personalizado

Las respuestas a una aplicación externa omiten el propietario de la conexión, el ID de instancia del elemento, el intervalo de sondeo y la marca Trae tu propia aplicación. La configuración de una conexión solo se devuelve a las personas que llaman que tienen el ámbito de lectura de la configuración, y los valores secretos como las claves API y los tokens OAuth nunca se devuelven.

Para obtener más información sobre cada punto final, consulta la guía de la API de Integration Service.