Utiliser l'API
Une API (Application Programming Interface) est une interface de programation qui permet d'accéder aux données d'un portail.
La documentation des API est réalisée en suivant la spécification OpenAPI 3.0, qui permet une description claire et compréhensible au travers d’une interface interactive. La prise en main des API par les développeurs est ainsi plus rapide.
Les API sont utilisées via des requêtes pour, par exemple, mettre à jour des données, ou pour en filtrer sur des jeux de données pouvant contenir des millions de lignes.
La plupart du temps, les API sont utilisées par des développeurs.
Documentation de l'API
Chaque jeu de données possède sa propre API.
Les portails mettent à disposition un visualisateur interactif de documentation d'API qui permet aux développeurs de réaliser des requêtes et de visualiser les résultats rapidement.
L'ensemble des fonctionalités est présenté sur la gauche de la documentation et le résultat sur la droite.
Sur l'image précédente, une requête pour obtenir les 10 premières lignes d'un jeu de données contenant plus de 16 millions de lignes est visible dans le visualisateur de documentation.
Le résultat est disponible dans l'encadré en bas à droite : réponse.
Différents paramètres (parameters) sont disponibles dans la section request si vous souhaitez obtenir des lignes différentes (augmenter le nombre de lignes, trier, etc.).
La documentation peut être lue dans un visualisateur externe, tel que Postman, SwaggerHub ou Stoplight.
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, par exemple.
Si vous n'avez pas accès à votre compte personnel en tant que compte actif, demandez à l'administrateur de votre organisation une clé d'API.
Lorsque votre clé est 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 sur le bouton UTILISER que vous trouvez en haut à droite de votre fiche.
La valeur de votre clé doit être contenue dans le header x-apiKey pour que vous soyez authentifié lors de votre requête API.
Si vous souhaitez aller plus loin dans l'utilisation, n'hésitez pas à nous contacter.
Il est possible de mettre à jour des jeux de données incrémentaux à l'aide de l'API ou encore d'utiliser les tableaux des données pour avoir des exemples de requêtes d'API poussées avec des filtres.