This document describes how to browse and search in the metadata catalogue and access referenced data using the B2FIND service using the CKAN API.
For a general introduction on how to use B2FIND please refer to the online User Guide.
Supported and tested browsers are:
- Firefox, version 45 or later
- Google Chrome, version 51 or later Make sure that JavaScript is enabled.
You can use your own CKAN installation (see module 04. Install CKAN), or directly access the B2FIND portal (we are open!). Please replace the variable CKAN_URL
with the URL of the CKAN site that is being used in the rest of this tutorial.
A CKAN instance can be accessed using the CKAN API. The basic client-server communication is shown in the following figure:
You can use different interfaces and methods for accessing B2Find.
These methods are listed below and each is described in detail in one of the following sections.
The figure below also show an overview of these methods.
- Direct HTTP: submit requests directly via http, (search using API).
- Graphical User Inteface: perform a facetted search using the powerful functionality provided on the website of the portal, (search using the GUI)
- Command Line Interface: submit your search requests by specifying arguments and options of the provided script, (search using the CLI)
Detailed guides for all three options are provided in the respective modules 05.a B2FIND and the CKAN API, 05.b Search using the Graphical User Interface (GUI), and 05.c Search using the Command Line Interface (CLI), illustrated by several use cases of faceted search and data analysis.
Finally, in the 05.d. Data Access module, it is explained how the underlying data collections can be retrieved using the offered references.