Akvo RSR API
From Akvo Labs
Contents |
RSR API
Changes to the Akvo RSR API were planned for 2011 but delayed by other priorities. We hope to have these rescheduled shortly.
The RSR API is a simple, read-only inteface to some of the data in Akvo-RSR. In the future we might expand it to a full REST-based two way tool for data management, but for the time being the goal is to expose some of our data so it can be used by our partners and other interested parties.
Code of conduct
We think it is great that you want to be using the Akvo RSR API. We think you can come up with a lot of new uses of the data that we haven't thought of or had time to do. There are just a couple of things that we would like you to respect with regards the usage of the API, to ensure that the system runs well and that what you do doesn't disrupt our system if you have an application that (unknowingly or not) doesn't play by the rules.
Follow the Akvo RSR API Code of conduct and everyone will be happy.
URLs
The base URL to the API is
http://www.akvo.org/rsr/api/
under which all paths return a data set in either XML or JSON format.
All data can be had as either JSON (default) or XML. This can be indicated in the URLs as shown by [json | xml]. For example all projects sponsored by Live Earth is output as XML via
http://www.akvo.org/rsr/api/projects.xml/live-earth/
JSON is what you get with
http://www.akvo.org/rsr/api/projects/live-earth/
or
http://www.akvo.org/rsr/api/projects.json/live-earth/
Project
Project data is available via the following paths:
All projects
projects[json|xml]/
All projects that are sponsored by Live Earth
projects[json|xml]/live-earth/
One project identified by its id (replace {id} with the actual number)
project[json|xml]/{id}/
ProjectUpdate
All updates belonging to a project identified by its id
project/{id}/updates[json|xml]/
One project update identified by its id
update[json|xml]/{id}/
Images
Data for images is given as a path. To get the image the path is added to the base media URL:
http://www.akvo.org/rsr/media/
