Acceso a la API

Información general

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

Aprende a registrar la aplicación externa en UiPath^® Automation Cloud.

Permisos de API

Para utilizar OpenAPI de Data Fabric , 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 Fabric.Schema.Read : este ámbito de usuario permite que tu aplicación externa lea el esquema de Data Fabric de tu tenant, y depende de los permisos del usuario.
• Data Fabric.Data.Read : este ámbito de usuario permite que tu aplicación externa lea los datos de Data Fabric de tu tenant, y depende de los permisos del usuario.
• Data Fabric.Data.Write : este ámbito de usuario permite que tu aplicación externa edite los datos de Data Fabric 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.

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 Fabric de tu tenant:

• En la página Data Fabric , 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 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 del tenant.

Autorizar las llamadas a API

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

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

  
  

  

  
  

  Ejemplo de entidad de Data Fabric

  Para describir cada cuerpo de solicitud/respuesta de la API, utilizamos los campos de entidad Olimpiadas creados en Data Fabric. 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 para profundizar en cada punto final y descubrir cómo puedes darle un buen uso.