CKAN- API
“CKAN est la solution logicielle leader qui permet de créer des portails de données ouvertes. CKAN soutient l’administration dans la centralisation des activités Open Data, le catalogage, le versionnement, le stockage et la journalisation des données publiées.”
Conditions préalables à l’utilisation de l’API
- Vous devez savoir comment lire JSON.
- Vous devez avoir compris les principes de base des API REST.
- Vous disposez d’une clé API à partir du tableau de bord du développeur.
Comment trouver la version la plus récente d’une ressource?
Nous utilisons comme exemple ‘timetable-2016-hrdf’ (horaire de période). La requête ‘package_list’ (voir ci-dessous) vous permet également de consulter les autres enregistrements possibles.
Vous devez faire le détour par les étapes 3 et 4, car les identifiants de ressources changent à chaque harvesting. Chaque ressource a toujours un identifiant de ressource unique.
Déroulement:
- Utiliser l’API CKAN
- Trouvez le slug du dataset (ici ‘timetable-2016-hrdf’) ou recherchez en général avec https://api.opentransportdata.swiss/ckan-api/package_list
- Lire le contenu du jeu de données https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf
- Rechercher à l’intérieur des ressources. Il faut charger le Periodic Timetable le plus récent. L’actualité peut être déterminée par la date (YYYY-MM-DD) dans le champ “url”.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "license_title":"Andere (Offen)", "resources":[ //…Other ressource { "byte_size":13851261, "coverage":"Coverage", // lot of attributes "title":"{\"fr\": \"Periodic timetable 2016 (HDRF)\", \"de\": \"Periodic timetable 2016 (HDRF)\", \"en\": \"Periodic timetable 2016 (HDRF)\", \"it\": \"Periodic timetable 2016 (HDRF)\"}", // lots of attributes "url":"https://opentransportdata.swiss/dataset/9f0babdc-0bdb-4400-b6fa-fd6d1f11cd5d/resource/e521f5d9-7f42-446f-9746-29ba2c26dfd8/download/fp20162016-09-24.zip", // lots of things // } |
- Avec l’URL (‘url’), vous pouvez télécharger le fichier
- Notez que l’horaire périodique suivant est toujours disponible à partir du mois de novembre environ (l’horaire annuel est disponible plus tôt). D’autres jeux de données, comme Didok, restent et sont indépendants de l’année de l’horaire..
Remarques importantes
L’API CKAN n’est pas conçue pour une charge très élevée : n’utilisez pas l’API CKAN comme entrepôt de données, mais pour des requêtes occasionnelles et l’identification automatique des ressources pour le téléchargement.
Autres métadonnées
Via https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf, vous obtenez également toutes les autres métadonnées pertinentes des données.
L’élément resources contient également les informations pertinentes sur une ressource individuelle.
Accès aux éléments de données individuels
L’accès aux différents champs est décrit à l’aide du pseudo-service Didok.
Informations supplémentaires