Acceso a la API

Información general

Data Service Open API allows you to manage UiPath^® Data Service resources from an external application of your choice, and does so by enabling you to authorize the external app without sharing any credentials, through the Oauth 2.0 authorization framework.

Learn how to register the external application in UiPath^® Automation Cloud.

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:

On the Data Service page, click API Access, then select Download OpenAPI file (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

Autoriza tu aplicación externa para que utilice el OpenAPI de Data Service creando un token de acceso para tu aplicación externa.el App ID y el App Secret que se generaron en el registro de la aplicación externa. 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.

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). Para seguir llamando a las API es necesario generar un nuevo token de acceso o solicitar un token de actualización.

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

Método HTTP + BaseURL + La categoría de recursos + 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.