Accès à l’API

Vue d'ensemble (Overview)

Data Fabric/Data Service Open API vous permet de gérer les ressources^UiPath® Data Fabric/Data Service à partir de l’application externe de votre choix. Cela permet d’autoriser l’application externe sans partager d’informations d’identification, via l’infrastructure d’autorisation Oauth 2.0.

Découvrez comment enregistrer une application externe.

Autorisations d'API

Pour utiliser OpenAPI Data Fabric/Data Service, vous devez accorder des autorisations d'API à l'application externe. Ces autorisations d'API sont appelées étendues et il existe trois types pour Data Fabric/Data Service:

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

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

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 Data Fabric/Data Service de votre locataire:

• Sur la page Data Fabric/Data Service, sélectionnez Accès à l'API, puis Télécharger le fichier OpenAPI.

Cette opération télécharge les spécifications OpenAPI 3.0 des entités Data Fabric/Data Service de votre locataire, au format JSON.

La sélection du lien Copier OpenAPI copie le point de terminaison de l'API qui génère la spécification OpenAPI Data Fabric/Data Service du locataire.

Autoriser les appels d'API

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

En savoir plus sur les méthodes d'autorisation pour les 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 Data Fabric/Data Service 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.

Un point de terminaison de Data Fabric/d'API Data Service a la syntaxe suivante:

• Méthode HTTP + BaseURL + La catégorie de ressource + L'entité Data Fabric/Data Service + L'opération + Les variables de chemin et les paramètres de requête

  

Exemple d'entité Data Fabric/Data Service

Pour décrire chaque corps de demande/réponse d'API, nous utilisons les champs d'entité v3D créés dans Data Fabric/Data Service. 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é.

Utilisons ensuite le guide de l’API Data Fabric/Data Service pour explorer chaque point de terminaison et découvrir comment l’utiliser.