Activer une API depuis un jeu de données - Cloud

Guide d'utilisation de Talend Cloud Data Inventory

Version
Cloud
Language
Français (France)
Product
Talend Cloud
Module
Talend Data Inventory
Content
Administration et monitoring > Gestion des connexions
Gouvernance de données
Qualité et préparation de données > Enrichissement de données
Qualité et préparation de données > Gestion des jeux de données
Qualité et préparation de données > Identification de données
Depuis la vue d'ensemble d'un jeu de données compatible, vous pouvez facilement activer une API donnant accès aux données qu'elle contient.

Avant de commencer

  • Si vous utilisez un moteur distant Gen2, vous avez démarré le moteur avec la commande suivante, pour utiliser un profil de moteur compatible : sudo ./remote-engine.sh start -r <region> -k <pair key> -p data-apis, où la valeur de votre région peut être us, eu, ap ou au.
  • Le rôle Dataset Administrator (Administrateur des jeux de données) ou Dataset Manager (Gestionnaire des jeux de données) vous a été attribué dans Talend Cloud Management Console, ou vous avez au moins les autorisations View API (Voir les API) et Manage API (Gérer les API).

Procédure

  1. Dans la liste des jeux de données, sélectionnez le jeu de données à rendre disponible via l'API.
  2. Pour commencer à configurer votre API, depuis la vue d'ensemble de votre jeu de données, vous pouvez :
    • Cliquez sur l'onglet API dans le menu de gauche.
    • Cliquez sur Enable (Activer) dans la tuile API.
  3. Cliquez sur Get started (Prendre en main) pour atteindre le formulaire de configuration de l'API.
  4. Saisissez un nom de jeu d'entités (Entity set name), constituant l'URL finale de l'API.
  5. Dans la liste déroulante Primary key (Clé primaire), sélectionnez le champ à utiliser pour sélectionner des enregistrements spécifiques depuis le jeu de données source.
    Le premier champ du jeu de données est sélectionné par défaut.
  6. Cliquez sur Add (Ajouter) pour commencer à définir les consommateur·trices qui seront autorisés pour appeler l'API.
  7. Saisissez le nom de la consommatrice ou du consommateur, dans le champ Name (Nom).
  8. Sélectionnez votre méthode d'authentification (Authentication) dans la liste déroulante Type.
    • Pour l'authentification basique Basic, définissez les identifiants à utiliser par le·a consommateur·trice, dans les champs Username (Identifiant) et Password (Mot de passe).
    • Pour l'authentification par Api key (Clé API), cliquez sur Generate API key (Générer une clé API) et copiez le jeton à utiliser dans votre en-tête de requête.
  9. Cliquez sur Add (Ajouter).
    Le·a consommateur·trice est à présent visible dans la liste. Vous pouvez en ajouter d'autres si vous le souhaitez.
  10. Pour finaliser la configuration de l'API et démarrer automatiquement l'API générée, cliquez sur Enable (Activer).

Résultats

De retour dans la vue API de votre jeu de données, vous pouvez voir deux tuiles :
  • La tuile Requests (Requêtes), dans laquelle vous pouvez monitorer l'activité de votre API des dernières 24 heures et voir si les appels sont réussis ou non.
  • La tuile API, avec une option pour activer ou désactiver rapidement l'API, les différents paramètres de configuration, l'URL de l'API à partager avec les consommateur·trices, ainsi qu'un modèle de requête avec plus d'expressivité. De là, vous pouvez retourner au formulaire de configuration pour modifier l'API et télécharger une définition OAS3 pour votre API.

Une vue d'ensemble du statut et de l'activité de l'API se trouve dans la tuile API de la vue d'ensemble du jeu de données.