Utiliser l'API sur le back office
Une API (Interface de Programmation d'Application) est une interface qui permet à deux logiciels de communiquer. Dans notre contexte, les API disponibles sur le portail ou le back-office permettent notamment d'accéder aux données.
La documentation des API suit la spécification OpenAPI 3.0, offrant une description claire et compréhensible via une interface interactive, ce qui facilite et accélère leur prise en main par les développeurs.
Les API sont utilisées par le biais de requêtes pour diverses opérations, telles que la mise à jour de données ou le filtrage de jeux de données pouvant contenir des millions de lignes.
En général, les API sont principalement utilisées par des développeurs.
Documentation de l'API
Chaque jeu de données dispose de sa propre API, accessible depuis la page d'édition du jeu de données dans le back-office.
Nous utiliserons l'API globale de l'organisation, disponible dans la barre de navigation du back office.
Dans la section de documentation de l'API, vous pouvez interagir avec l'API et obtenir les réponses à vos requêtes. La documentation peut également être consultée via des visualisateurs externes tels que Postman, SwaggerHub ou Stoplight.
Nous utiliserons l'API pour obtenir la syntaxe des requêtes à envoyer avec la commande curl.
Consultez la documentation de l'API pour plus de détails.
- Documentation
- Utiliser l’API
- Choix des types des requêtes
Dans notre exemple, nous allons créer un jeu de données en utilisant notre clé d'API.
Sélectionnez la section Jeux de données dans les types de requêtes.
L'interface de la documentation de l'API est actuellement en cours d'évolution, et les images ne reflètent pas encore la version actuelle.
- Sélection du type de requêtes
- Ajout d’un jeu de données (Post)
- Effectuer une requête
- Notre clé d’API
- Fichier à importer
- Exécution de la requête
- Réponse de la requête
- Commande curl
Les étapes 1 à 6 nous permettent de tester l'envoi d'une requête.
Une fois que vous avez cliqué sur le bouton Execute, la réponse de l'API est visible à l'étape 7.
L'étape 8 nous permet de voir la syntaxe de la commande envoyée, comme si nous avions utilisé la commande curl.
Les étapes 1 à 6 nous permettent de tester l'envoi d'une requête.
Une fois que vous avez cliqué sur le bouton Exécuter, la réponse de l'API est visible à l'étape 7.
L'étape 8 nous permet de voir la syntaxe de la commande envoyée, comme si nous avions utilisé la commande curl.
Plusieurs exemples de commandes curl sont disponibles sur la page intitulée : Exemples API.
Clé d'API
Un clé d'API permet d'augmenter le taux de demandes de requêtes et son débit de téléchargement.
Un contributeur peut générer sa propre clé sur son espace personnel pour réaliser des tests sur son compte personnel, par exemple.
Si vous n'avez pas accès à votre compte personnel en tant que compte actif, demandez à l'administrateur de votre organisation de vous fournir une clé d'API.
Vous pouvez accéder aux paramètres de votre compte via la barre de navigation de Data Fair.
Cliquez sur Paramètres et rendez-vous dans la section Clé d'API.
Indiquez le nom de votre clé et sélectionnez sa portée (jeux de données, applications, connecteurs aux catalogues ou récupération d'informations statistiques).
Une fois votre clé créée, copiez la valeur de la clé secrète. C'est cette clé que vous utiliserez dans vos appels.
Pour savoir comment utiliser la clé, un exemple vous est fourni en cliquant sur le bouton UTILISER situé en haut à droite de votre fiche.
Pour être authentifié lors de votre requête API, assurez-vous que la valeur de votre clé est incluse dans le header x-apiKey.
Il est également possible de mettre à jour des jeux de données incrémentaux via l'API ou d'utiliser les tableaux de données pour obtenir des exemples de requêtes API avancées avec des filtres.
Si vous avez des remarques sur ce cours, n'hésitez pas à nous les communiquer.