Using the CKAN API

Brief Description

CKAN is an open-source data catalogue software (project website: https://ckan.org/ ). We use CKAN for our data collection https://data.opentransportdata.swiss/.

Through the CKAN API, metadata about our datasets and APIs (e.g. download links, update date, etc.) can be retrieved and used as needed.

Functional Description

We maintain all of our approximately 90 records (1000+ resources or files) as well as our APIs in CKAN. CKAN stores a range of metadata for the records and resources, including:

• Names (titles) and brief descriptions of records and resources
• Date and time of creation and update
• Media types (mime types)
• Permalinks, download links and links to documentation (Cookbook)

This metadata is displayed on the web pages, but it can also be retrieved via the CKAN API and used in an application.

Technical Description

An API key is required to access the API. For instructions, see here:

https://opentransportdata.swiss/de/cookbook/development-miscellaneous-cookbook/howto-access-apis/

The API is a simple REST API. Essentially, these two endpoints can be used:

• https://api.opentransportdata.swiss/ckan-api/package_list returns a list of datasets (names, ‘slugs’)
• https://api.opentransportdata.swiss/ckan-api/package_show?id=dataset_name provides detailed metadata for the given dataset_name. In the field ressources list the relevant information for each individual resource.

The answers are formatted in JSON. The fields and content are largely self-explanatory.

Please note

• The CKAN API should only be used for occasional queries on individual records, not for frequent full scans, etc.
• Metadata can also be retrieved via DCAT Catalog files at:
  • https://data.opentransportdata.swiss/catalog.xml
  • https://data.opentransportdata.swiss/catalog.ttl

Further information

• http://ckan.de/das-open-data-projekt/
• https://docs.ckan.org/en/latest/api/
• https://en.wikipedia.org/wiki/Data_Catalog_Vocabulary

 

 

#AutoTranslate