| 5 | | The API takes the form of a RESTful (Representational State Transfer) style API for accessing CKAN database objects and a Search API. |
| 6 | | |
| 7 | | For full details of accessing the API, see the CKAN developer documentation at http://packages.python.org/ckan/api.html |
| 8 | | |
| 9 | | == API Clients == |
| 10 | | |
| 11 | | === PHP client === |
| 12 | | Ckan_client-PHP is an almost full and (I hope) easy-to-use interface to the CKAN APIs. |
| 13 | | * Source: [http://github.com/jeffreybarke/Ckan_client-PHP] |
| 14 | | * Author: Jeffrey Barke |
| 15 | | |
| 16 | | This example uses CKAN's search API and lists and reads Packages/Groups with the REST API. |
| 17 | | * [http://www.practicalweb.co.uk/blog/10/02/23/accessing-ckan-data-php] |
| 18 | | * Author: [http://practicalweb.co.uk/ Sean Burlington] |
| 19 | | |
| 20 | | === Perl client example === |
| 21 | | This example accesses the CKAN REST API to get a list of the packages, count the uses of an 'extra' field and then plots it with the Google chart API. Luke broke the CKAN bits out into a CKAN specific client library - Net::CKAN. Luke is open to improving this library and eventually releasing it to CPAN. |
| 22 | | * Script Source: [http://github.com/lukec/net-ckan/blob/master/bin/make-ckan-chart] |
| 23 | | * Library Source: [http://github.com/lukec/net-ckan/blob/master/lib/Net/CKAN.pm] |
| 24 | | * Info: [http://lists.okfn.org/pipermail/ckan-discuss/2010-February/000057.html] |
| 25 | | * Author: Luke Closs |
| 26 | | |
| 27 | | === Python client === |
| 28 | | Ckanclient is a python module that provides an full and easy-to-use interface to the CKAN APIs. |
| 29 | | * About: [http://www.ckan.net/package/ckanclient] |
| 30 | | * PyPI releases: [http://pypi.python.org/pypi/ckanclient/0.2] |
| 31 | | * Code info: [http://knowledgeforge.net/ckan/ckanclient] |
| 32 | | * Author: OKFN |
| 33 | | |
| 34 | | === Command-line client === |
| 35 | | Datapkg allows you to download the data in CKAN packages on the command-line, in the style of software package managers (e.g. apt-get, cpan, pypi). |
| 36 | | * Docs: [http://packages.python.org/datapkg/] |
| 37 | | * Source: [http://bitbucket.org/okfn/datapkg] |
| 38 | | |
| 39 | | == Other Code related to CKAN == |
| 40 | | |
| 41 | | === Drupal module === |
| 42 | | Simple module: |
| 43 | | * [http://www.practicalweb.co.uk/blog/10/02/24/drupal-module-ckan-integration] |
| 44 | | * Author: [http://practicalweb.co.uk/ Sean Burlington] |
| 45 | | |
| 46 | | Advanced module: |
| 47 | | * [http://data.gov.uk/blog/datagovuk-releases-open-source-code Blog post] |
| 48 | | * [http://data.gov.uk/sites/default/files/ckanpackage.tar.gz ckanpackage.tar.gz] (and available on drupal.org shortly) |
| 49 | | * Author: Data.gov.uk |
