Acceso a la API

Información general

La API abierta de Data Fabric/Data Service te permite gestionar los recursos de^UiPath® Data Fabric/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.

Descubre cómo registrar una aplicación externa.

Permisos de API

Para utilizar OpenAPI de Data Fabric/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 Fabric/Data Service:

• Data Fabric/Data Service.Schema.Read : este ámbito de usuario permite a tu aplicación externa leer el esquema de Data Fabric/Data Service de tu tenant, y depende de los permisos del usuario.
• Data Fabric/Data Service.Data.Read : este ámbito de usuario permite a tu aplicación externa leer los datos de Data Fabric/Data Service de tu tenant, y depende de los permisos del usuario.
• Data Fabric/Data Service.Data.Write : este ámbito de usuario permite a tu aplicación externa editar los datos de Data Fabric/Data Service de tu tenant eliminando, actualizando o creando nuevos datos, y depende de los permisos del usuario.

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

Descargar la especificación de OpenAPI

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

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

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

Al seleccionar Copiar enlace OpenAPI se copia el punto final de la API que genera la especificación OpenAPI de Data Fabric/Data Service del tenant.

Autorizar las llamadas a API

Autoriza tu aplicación externa para utilizar Data Fabric/Data Service OpenAPI creando un token de acceso para tu aplicación externa. Utiliza el ID de aplicación y el Secreto de aplicación 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 tu aplicación externa realizar llamadas a la API REST a puntos finales de Data Fabric/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 Fabric/Data Service tiene la siguiente sintaxis:

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

  

Ejemplo de entidad de Data Fabric/Data Service

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

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