L'API REST simplifie vos interactions avec les données stockées sur le serveur de Talend Dictionary Service en utilisant un certain nombre de méthodes ou de types de requêtes.
Vous pouvez accéder à toutes les pages de la documentation de l'API REST basée sur Swagger et exécuter des requêtes. Vous pouvez télécharger un fichier JSON à partir des pages de documentation de l'API REST.
Avant de commencer
Vous devez avoir installé et configuré Talend Dictionary Service lors de l'installation de Talend Data Stewardship ou de Talend Data Preparation.
Vous êtes connecté(e) à Talend Data Stewardship ou Talend Data Preparation.
Procédure
-
Démarrez tous les modules dans le dossier d'installation de Talend Data Stewardship ou Talend Data Preparation, selon l'application depuis laquelle vous souhaitez accéder à la documentation.
Remarque : Pour accéder à l'API REST de Talend Dictionary Service depuis Talend Data Preparation, vous devez d'abord configurer la valeur du paramètre service.documentation à true dans le fichier de configuration <Installation_Path>/dataprep/config/application.properties.
-
Ouvrez un navigateur Web et saisissez l'URL suivante où
<host> et <port> dépendent de votre installation :
http://<host>:<port>/docs/api/swagger-ui.html
-
Ouvrez un navigateur Web et saisissez l'URI suivante : https://tds.{region}.cloud.talend.com/docs/api/swagger-ui.html.
-
Dans le champ en haut de la page, sélectionnez Semantic Service pour ouvrir la page de documentation de Talend Dictionary Service dans laquelle les opérations sont classées en différentes catégories.
Exemple
-
Cliquez sur un nom de catégorie pour afficher la liste d'opérations de la catégorie.
-
Cliquez sur et utilisez vos identifiants pour vous connecter.
Dans la zone Response Headers, vous obtenez un jeton (bearer) d'authentification.
-
Commencez à tester l'exécution des différentes opérations.
Pour obtenir les résultats des opérations exécutées, utilisez la commande Curl obtenue dans la réponse.
Incluez le jeton Bearer obtenu lorsque vous vous connectez comme partie de votre en-tête d'autorisation.
Exemple
curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://<host>:<port>/categories?caseSensitive=false&isExact=false'
