IDS API Module
--------------
This module provides a Drupal 7 interface for the Institute for Development Studies (IDS)'s Open API (http://api.ids.ac.uk/).
The goal of the module is to allow retrieving data from the IDS Collections (Eldis and Bridge) for use within a Drupal site.
* Setup *
- Install this module in the usual manner.
- Get an API key from IDS (http://api.ids.ac.uk/accounts/login/) and enter it in the module's configuration page:
'/admin/config/services/idsapi'.
- Optionally, configure additional settings (default dataset, default number of items retrieved, cache time).
Please note that the module is designed to cache API responses in order to minimise external calls.
The module handles paged responses (overriding the API's default number of items).
* Instructions *
- API calls are implemented through the class IdsApiRequest (idsapi.request.inc).
- Items retrieved are made available to Drupal by an object of class IdsApiResponse (idsapi.response.inc), which includes
the total number of items retrieved and an array of objects retrieved implemented by subclasses of IdsApiObject (for instance:
IdsApiObjectAssetDocument, IdsApiObjectAssetOrganisation, etc.).
Example (to retrieve the complete information of the 20 most recent documents added to the Eldis collection focused on Afghanistan):
$request = new IdsApiRequest();