Acceso a la API

Información general

Data Service Open API te permite gestionar los recursos de UiPath^® Data Service desde una aplicación externa de tu elección, y lo hace permitiéndote autorizar la aplicación externa sin compartir ninguna credencial, a través del marco de autorización OAuth 2.0.

Permisos de API

Para utilizar el OpenAPI de Data Service, debes conceder permisos de API a la aplicación externa.Estos permisos de API se conocen como ámbitos, y hay tres tipos para Data Service:

• DataService.Schema.Read: este Ámbito de usuario permite a tu aplicación externa leer el esquema de Data Service de un inquilino, y depende de los permisos del usuario.
• DataService.Data.Read: este Ámbito de usuario permite a tu aplicación externa leer los datos de Data Service de un inquilino, y depende de los permisos del usuario.
• DataService.Data.Write: este Ámbito de usuario permite a tu aplicación externa editar los datos de Data Service de un inquilino, eliminar y crear nuevos datos, y depende de los permisos del usuario.

Más información sobre los roles de usuario y permisos en Data Service.

Descargar la especificación de OpenAPI

Una vez que hayas establecido los permisos para tu aplicación externa y tus usuarios, descarga la especificación OpenAPI de los datos de Data Service de tu tenant:

• En la página Data Service, haz clic en Acceso a la API y, a continuación, selecciona Descargar archivo OpenAPI (JSON).

Esta operación descarga las especificaciones de OpenAPI 3.0 de las entidades de Data Service de tu tenant, en formato JSON.

Al hacer clic en el enlace Copiar OpenAPI se copia el punto final de la API que genera la especificación OpenAPI de Data Service del tenant.

Autorizar las llamadas a API

Para acceder a los recursos de ámbito de usuario de Data Service, autoriza tu aplicación externa con uno de los siguientes métodos:

• Código de autorización (para aplicaciones externas confidenciales)

• Código de autorización con PCKE (para aplicaciones externas no confidenciales)

Puntos de conexión de API

El marco de autorización OAuth2.0 te ayuda a generar un token de acceso que permite a su aplicación externa realizar llamadas a la API REST a los puntos finales de Data Service durante un tiempo limitado (una hora).

Un punto final de la API de Data Service tiene la siguiente sintaxis:

• Método HTTP + BaseURL + La categoría del recurso + La entidad de Data Service + La operación + Variables de ruta y parámetros de consulta

  
  

  

  
  

  Ejemplo de entidad de Data Service

  Para describir cada cuerpo de solicitud/respuesta de la API, utilizamos los campos de entidad Olimpiadas creados en Data Service. Mientras documentamos el punto final genérico, como Get Entity Records, su punto final contiene el nombre exacto de su entidad (por ejemplo, Get Olympics Records). Los cuerpos de respuesta y solicitud incluyen todos los campos de su entidad, replicando la estructura de la misma.
  
  

  

  
  

  Además, utilicemos la guía de la API de Data Service para profundizar en cada punto final y descubrir cómo puedes darle un buen uso.

Acceder a los recursos de Data Service mediante aplicaciones externas

Configuración de acceso refinado para aplicaciones externas

Las aplicaciones externas utilizan sus propias credenciales de cliente para acceder a los recursos de Data Service en lugar de suplantar a un usuario.

Cuando una aplicación externa quiere realizar una acción dentro de una entidad, Data Service comprueba si la aplicación tiene los permisos necesarios para acceder a los recursos correspondientes. Como ningún usuario participa en la autenticación, la solicitud de cualquier recurso genera un token de acceso que verifica las asignaciones que tiene tu aplicación a nivel de tenant y entidad. Solo después de una validación exitosa, la aplicación externa obtiene acceso a los recursos para los que se le han otorgado permisos.

Crear aplicaciones externas

Como administrador, sigue estos pasos para crear una aplicación externa y configurarla para acceder a los recursos de Data Service:

1. En tu organización, ve a Admin > Aplicaciones externas. Se mostrará la página Aplicaciones externas .

2. Haz clic en Añadir aplicación:

   1. Proporcione un nombre para su aplicación externa.

   2. Selecciona el tipo para tu aplicación externa.

   3. Haz clic en Añadir. Tu aplicación externa se muestra en la lista de aplicaciones externas .

Di algo sobre el ámbito dataService.default Para las aplicaciones confidenciales a las que se han asignado roles personalizados de Data Service, debes solicitar el ámbito DataService.Default . Este ámbito utiliza un token de acceso para comprobar las asignaciones que tiene tu aplicación en los niveles de tenant y entidad. Solo después de una validación exitosa, la aplicación externa puede acceder a los recursos a los que se le ha otorgado acceso.

Adición de apps externas a un tenant

Como administrador de Data Service, sigue estos pasos para conceder acceso a una aplicación externa a todas las entidades del tenant seleccionado:

1. En tu instancia de Data Service, ve a la página Gestionar acceso .

   

2. En la página Gestionar acceso , haz clic en el botón Asignar roles .

3. En el panel Asignar roles :

   1. En el campo Añadir nombres , escribe el nombre de tu aplicación externa y selecciónala de la lista.

   2. En la lista Seleccionar roles , selecciona el rol personalizado creado previamente y el rol Lector de datos . Puedes seleccionar otros roles que quieras asignar a tu aplicación externa, pero Data Reader es una selección obligatoria.

   3. Haz clic en Guardar. Tu aplicación externa se muestra en la lista de la pestaña Asignar roles .

      

Añadir aplicaciones externas a una entidad

Como administrador de Data Service, sigue estos pasos para gestionar el acceso de una aplicación externa a entidades específicas:

1. En tu instancia de Data Service, ve a la página Gestionar acceso .

   

2. En la página Gestionar acceso , haz clic en el botón Crear rol .

3. En el panel Crear rol :

   1. Proporciona un nombre para el rol personalizado.

   2. Asigna los permisos administrativos deseados.

   3. En la sección Permisos de acceso a datos , haz clic en Añadir entidad, selecciona la entidad deseada y, a continuación, selecciona los permisos que la aplicación externa puede tener dentro de esa entidad.

   4. Haz clic en Guardar. El rol personalizado para tu aplicación externa se muestra en la lista de la pestaña Roles .