This user guide covers using CKAN’s web interface to organize, publish and find data. CKAN also has a powerful API (machine interface), which makes it easy to develop extensions and links with other information systems.
The Web/User Interface for normal users are provided by official CKAn documentation: https://docs.ckan.org/en/2.8/user-guide.html
For HEF AgriHUb we use also several other extensions which change to some extent the default behaviour of CKAN core catalog. In order to compensate for this discrepancy, we prepared some tutorial videos. They are available via HEF Youtube channel "AgriHub Catalog".
| Topic | Video |
|---|---|
Smart Rural Areas Data Infrastructure CatalogThis demo is prepared for the DLA conference and with the aim to better represent for whom the distributed Digital Twin of the SRADI (Smart Rural Areas Data Infrastructure) is designed. In this demo, the structure of the SRADI catalog is discussed and an instance of the catalog is presented. | |
HEF AgriHUB Creating AccountIn this video, you will learn how to create your account with proper access rights in the “HEF AgriHUB”. | |
HEF AgriHUB Creating a new resource entryIn this video, you will learn how to create a new entry for a resource in the catalog “HEFAgriHUB”. |
CKAN’s Action API is a powerful, RPC-style API that exposes all of CKAN’s core features to API clients. All of a CKAN website’s core functionality (everything you can do with the web interface and more) can be used by external code that calls the CKAN API. For example, using the CKAN API your app can:
Get JSON-formatted lists of a site’s datasets, groups or other CKAN objects:
Get a full JSON representation of a dataset, resource or other object:
https://agrihub.hef.tum.de/api/3/action/package_show?id=grafana
https://agrihub.hef.tum.de/api/3/action/tag_show?id=sensor
https://agrihub.hef.tum.de/api/3/action/group_show?id=device
Search for packages or resources matching a query:
https://agrihub.hef.tum.de/api/3/action/package_search?q=3d
https://agrihub.hef.tum.de/api/3/action/resource_search?query=name:District%20Names
Create, update and delete datasets, resources and other objects
Get an activity stream of recently changed datasets on a site:
https://agrihub.hef.tum.de/api/3/action/recently_changed_packages_activity_list
The CKAN also provides additional functions which can be applied using HTTP POST request. For more info, please refer to https://docs.ckan.org/en/2.8/api/index.html
CKAN Extension - CKANAPI
Source (Github): https://github.com/ckan/ckanapi
A command line interface and Python module for accessing the CKAN Action API
By this extension, one can remotely connect to a ckan catalog and those not need necessarily to run it on the same server as the ckan catalog