Accès à l’API

Vue d'ensemble (Overview)

Ouvrir l’API de Data Fabric vous permet de gérer les ressources^UiPath® Data Fabric à partir d’une application externe de votre choix en vous permettant d’autoriser l’application externe sans partager d’informations d’identification via le cadre d’autorisation Oauth 2.0.

Découvrez comment enregistrer l'application externe dans UiPath^® Automation Cloud.

Autorisations d'API

Pour utiliser OpenAPI de Data Fabric , vous devez accorder des autorisations d'API à l'application externe. Ces autorisations d'API sont nommées « étendues », et il en existe trois types pour Data Fabric:

• Data Fabric.Schema.Read : cette étendue d'utilisateur (User Scope) permet à votre application externe de lire le schéma Data Fabric de votre locataire, et dépend des autorisations de l'utilisateur.
• Data Fabric.Data.Read : cette étendue d'utilisateur (User Scope) permet à votre application externe de lire les données Data Fabric de votre locataire, et dépend des autorisations de l'utilisateur.
• Data Fabric.Data.Write : cette étendue d'utilisateur (User Scope) permet à votre application externe de modifier les données Data Fabric de votre locataire en supprimant, en mettant à jour ou en créant de nouvelles données, et dépend des autorisations de l'utilisateur.

En savoir plus sur les rôles et les autorisations des utilisateurs dans Data Fabric.

Télécharger la spécification OpenAPI

Une fois que vous avez défini les autorisations pour votre application externe et vos utilisateurs, téléchargez la spécification OpenAPI des données de votre locataire Data Fabric :

• Sur la page Data Fabric , sélectionnez Accès à l'API(API Access), puis sélectionnez Télécharger le fichier OpenAPI (JSON) (Download OpenAPI file (JSON)).

Cette opération télécharge les spécifications OpenAPI 3.0 des entités Data Fabric locataires, au format JSON.

Sélectionner le lien Copier le lien OpenAPI (Copy OpenAPI link) copie le point de terminaison d'API qui génère la spécification OpenAPI de Data Fabric dans le locataire.

Autoriser les appels d'API

Autorisez votre application externe à utiliser Data Fabric OpenAPI en créant un jeton d'accès pour votre application externe. Utilisez l' identifiant de l'application et la clé secrète de l'application générés lors de l'enregistrement de l'application externe. Le mode d'autorisation dépend du type d'application (confidentiel ou non confidentiel).

En savoir plus sur les méthodes d'autorisation des applications externes.

Points de terminaison de l’API

Le cadre d'autorisation OAuth2.0 vous aide à générer un jeton d'accès qui permet à votre application externe d'effectuer des appels d'API REST aux points de terminaison de Data Fabric pendant une durée limitée (une heure).

Pour continuer à appeler les API, vous devez générer un nouveau jeton d'accès ou demander un jeton d'actualisation.

Les points de terminaison de l'API Data Fabric présentent la syntaxe suivante :

• Méthode HTTP + BaseURL + La catégorie de ressource + L'entité Data Fabric + L'Opération + Les variables de chemin d'accès et les paramètres de recherche

  
  

  

  
  

  Exemple d'entité Data Fabric

  Pour décrire chaque corps de recherche/réponse API, nous utilisons les champs d'entité Jeux olympiques (Olympics ) créés dans Data Fabric. Lorsque nous documentons le point de terminaison générique, tel que Get Entity Records, votre point de terminaison contient le nom exact de votre entité (par exemple, Get Olympics Records). Les corps de réponse et de demande incluent tous les champs de votre entité, reproduisant ainsi la structure de l'entité.

  De plus, utilisons le guide de l'API Data Fabric pour découvrir chaque point de terminaison et découvrir comment les utiliser à bon escient.