Utiliser l’API opendata.swiss

Comment programmer l’accès aux données d’opendata.swiss?

opendata.swiss se fonde sur le projet open source CKAN. Ce dernier met à disposition des développeurs d’applications une API complète pour les métadonnées du catalogue de données ouvertes. Dans ce chapitre, nous vous expliquons comment utiliser l’API pour accéder aux données d’opendata.swiss. Quelques exemples d’applications actuelles illustrent de quelle manière les OGD peuvent vous être utiles.

Comment utiliser les API

Bon à savoir

Vous trouverez ici une introduction succincte du recours à l’API d’opendata.swiss. La documentation détaillée de l’API CKAN peut être consultée ici.

Accès possibles

Vous pouvez choisir parmi trois options d’accès à opendata.swiss:

Accès à l’API via le navigateur
https://opendata.swiss/api/3/action/package_search?fq=tags:economy
Accès à l’API via une interface en ligne de commande, cURL par exemple
curl 'https://opendata.swiss/api/3/action/package_search?fq=tags:economy'
Accès à l’API via l’outil CKAN ckanapi
 ckanapi -r https://opendata.swiss action package_search fq='tags:economy'

Action API

Les accès utilisent tous le terme «action», comme l’illustrent les exemples ci-dessus. En principe, la plupart des fonctions CKAN sont programmées sous forme d’«action» de sorte à pouvoir être lancées via l’API. Vous en apprendrez davantage au paragraphe Action API de la documentation CKAN.

Terminologie CKAN dans opendata.swiss

Les objets opendata.swiss sont également représentés dans CKAN. Pour faciliter votre utilisation de l’API, la liste ci-dessous énumère la terminologie vous permettant d’accéder aux différentes unités d’opendata.swiss:

package, dataset

Ce terme est synonyme de jeu de données sur opendata.swiss. Il s’agit des métadonnées d’un paquet de ressources.

resource

Le terme utilisé par opendata.swiss est ressource. La plateforme opendata.swiss n’héberge aucune ressource, elle se contente de mettre à disposition des «downloadUrls» (téléchargement) et des «accessUrls» (accès), en partie aussi des prévisualisations de données. Les ressources dans CKAN correspondent à dcat:Distribution dans la norme DCAT AP.

group

Il correspond à une catégorie chez opendata.swiss. Un même dataset peut appartenir à plusieurs catégories.

organization

Correspond au fournisseur de données, qu’il s’agisse d’un particulier ou d’une organisation. Chaque jeu de données est publié par une seule organisation.

id

Dans l’API, il s’agit de l’identifiant (slug) du jeu de données.

Exemples

  • Établir une liste de jeux de données:

package_list: auflisten aller datasets
curl 'https://opendata.swiss/api/3/action/package_list'
  • Afficher un jeu de données:

package_show, id: anzeigen eines einzelnen datasets
curl 'https://opendata.swiss/api/3/action/package_show?id=studierende-fachhochschule-anz'
  • Rechercher des jeux de données en fonction d’un mot-clé:

package_search, q, fq: Schlagwortsuche in den Datasets
curl https://opendata.swiss/api/3/action/package_search?q=switzerland&fq=+keywords_en:geology'

CKAN utilisant Solr comme moteur de recherche, la syntaxe de recherche correspond à Apache Lucene. Vous trouverez des explications détaillées dans la documentation CKAN.

Fetch API

Vous pouvez aussi accéder à opendata.swiss via Fetch API.

Support

Des questions?

Avez-vous des questions sur l’utilisation de notre API? N’hésitez pas à nous écrire. Pour toute question concernant un jeu de données spécifique, veuillez contacter le fournisseur de données. Vous trouverez les coordonnées pour chaque jeu de données sous «Informations complémentaires».

Souhaitez-vous nous soumettre un exemple d’application intéressant? Nous serions très heureux de le découvrir et d’inclure votre projet dans notre galerie d’exemples. Écrivez-nous.

Informations complémentaires