Introduction à l'API Automation

L'accès à l'API Automation dépend de votre plan et de vos options. Consultez votre page Plans pour avoir une vue d'ensemble des plans.

Si vous êtes déjà familiarisé avec les API et l'API Automation, vous pouvez accéder directement à la documentation de l'API Automation v1. Sinon, continuez à lire pour plus de détails.

Une API, ou interface de programmation d'application, est un outil conçu pour permettre à différents systèmes logiciels de communiquer entre eux. Opendatasoft fournit plusieurs API pour interagir avec la plateforme, mais l'API d'automatisation d'Opendatasoft peut être très utile pour automatiser vos processus de gouvernance des données et vous assurer que les données publiées sur votre portail sont toujours à jour.

L'Automation API d'Opendatasoft vous permet d'effectuer toutes les actions disponibles dans le back office d'un espace de travail. Voici une liste non exhaustive de ces actions :

• Ajouter des données à Opendatasoft : Connectez-vous à vos services distants, récoltez un autre portail ou fédérez Opendatasoft Hub.

• Enrichir vos données : Décrivez vos jeux de données à l'aide de métadonnées ou ajoutez l'un des nombreux processeurs de données disponibles.

• Publier vos données : Publiez un jeu de données sur votre portail, gérez les horaires de mise à jour pour maintenir vos données fraîches.

• Gérer vos pages : Créez et gérez les pages Studio et Code Editor.

• Gérer votre domaine : Gérez les utilisateurs et les groupes.

Si vous étiez un utilisateur de l'API Management v2, celle-ci sera obsolète dans les prochains mois et sera remplacée par l'API Automation, car cette dernière est plus puissante et offrira plus de fonctionnalités :- Nouveaux connecteurs (Sharepoint, Google Drive, Azure Blob Storage, Amazon S3 etc.)- Gestion des connexions sauvegardées- Fédération de jeux de données à partir du Hub Opendatasoft- Modèles de métadonnées

L'utilisation de l'API Automation nécessite une authentification en tant qu'utilisateur Opendatasoft. Deux options sont possibles :

1. Une clé d'API dans l'en-tête de la requête (recommandé).
   Les en-têtes d'API sont comme une source supplémentaire d'informations pour chaque appel API que vous effectuez. Leur rôle est de contenir les métadonnées associées à une requête et à sa réponse. Pour utiliser cette option, fournissez une clé d'API existante pour votre espace de travail Opendatasoft dans l'en-tête "Authorization", comme suit : apikey<votreclédapi>.

2. Une clé d'API dans la chaîne de requête (moins sécurisé), comme ceci : <votre requête>?apikey=<votreclédapi>

Notez que l'authentification "Basic Authentication" ne peut plus être utilisée.

Alors, comment procéder réellement à l'utilisation de l'API ? Comme nous l'avons vu précédemment, utiliser l'API consiste à lui demander quelque chose et à recevoir une réponse en retour. Dans le langage des API, vous effectuez un "appel" ou une "requête" et vous recevez, dans ce cas, un objet JSON en retour.

Ainsi, lorsque vous utilisez l'API, votre appel API est envoyé au serveur Opendatasoft, et vous obtenez en réponse un objet JSON.

Vous voudrez utiliser d'autres outils pour rendre l'interaction avec l'API plus pratique et utile. Par exemple, les appels API peuvent être effectués à l'aide de plateformes telles que Postman, conçues pour interagir avec les API. Si vous êtes développeur, vous pouvez utiliser Curl ou la bibliothèque Requests de Python.

Il est facile de voir cela en action dans votre propre espace de travail. Par exemple, vous pouvez demander à l'API de vous fournir une liste de tous les jeux de données existants. Dans votre navigateur, saisissez : https://<votreidentifiantdedomaine>.opendatasoft.com/api/automation/v1.0/datasets?apikey=<votreclédapi>. Remplacez les variables <votreidentifiantdedomaine> et <votreclédapi> par les valeurs appropriées. (Consultez ici pour plus d'informations sur la génération de clés d'API.)Ce que vous devriez voir, c'est un objet JSON contenant une liste des jeux de données de votre domaine, avec des liens vers d'autres objets JSON. C'est l'API en action ! Bien sûr, en soi, cela n'est pas très intéressant. Mais utilisée avec d'autres outils, l'API peut être un moyen puissant d'interagir avec vos données.

Nous espérons que cette page vous aide à comprendre comment l'API Automation peut vous être utile.

Il est indéniable que l'utilisation d'une API n'est pas destinée à tout le monde. Mais avec un peu de travail, l'API peut vous permettre de publier facilement des données sur votre portail.

Pour vous accompagner tout au long du processus, nous vous invitons à plonger dans notre documentation pour l'API Automation v1 !