Activer une API depuis un jeu 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 Management Console, ou vous avez au moins les autorisations View API (Voir les API) et Manage API (Gérer les API).

Procédure

Dans la liste des jeux de données, sélectionnez le jeu de données à rendre disponible via l'API.
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.
Cliquez sur Get started (Prendre en main) pour atteindre le formulaire de configuration de l'API.
Saisissez un nom de jeu d'entités (Entity set name), constituant l'URL finale de l'API.
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.
Cliquez sur Add (Ajouter) pour commencer à définir les consommateur·trices qui seront autorisés pour appeler l'API.
Saisissez le nom de la consommatrice ou du consommateur, dans le champ Name (Nom).
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.
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.
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 Consuming (Consommation), avec l'URL de l'API à partager avec les consommateurs qui dépend de si vous utilisez le protocole http ou https, des exemples de requêtes avec plus d'expressivité pouvant être facilement réutilisés, ainsi qu'un bouton de téléchargement pour récupérer une définition OAS3 de votre API. Vous pouvez également utiliser le bouton Open in API Tester (Ouvrir dans API Tester) pour tester un appel d'API préconfiguré dans Talend API Tester.
La tuile Monitoring, 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.

Vous pouvez utiliser l'option Enable API (Activer l'API) pour activer ou désactiver rapidement l'API en fonction de la situation ou cliquer sur Edit (Modifier) pour retourner au formulaire de configuration.

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.

Important : Un problème connu peut vous empêcher d'activer une API à partir d'un jeu de données partagé avec vous, si :

le jeu de données est partagé avec des groupes d'utilisateur·trices. Dans ce cas, essayez de partager le jeu de données avec d'autres utilisateur·trices, individuellement.
la dernière personne ayant modifié le jeu de données ou sa connexion n'a plus ses droits sur le jeu de données. Dans ce cas, essayez de le partager à nouveau avec cette personne ou contactez le Support Talend pour une mise à jour du jeu de données.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici