Habib's Garden
Connecting People to Weave a Better World
It is with great sadness that we report the death of Steve Habib Rose. A number of us met this evening and thought that this group would be a fitting tribute. Lets use this group to recognize, honor and appreciate the many gifts and blessings he bestowed on so many of us. Please add yourself and your reflections.
GROUP DETAILS
Created: Sep 26, 2007
Updated: Jul 22, 2009
Membership: Open
Public
What data is available through the API?
What kind of API will WiserEarth be providing?
How do I properly attribute WiserEarth under the Creative Commons Licence?
Where can I find the API documentation?
Can you help me implement the API on our platform or service?
How much of the API has been completed?
When will the API be launched?
What data is available through the API?
All data fields associated with the following WiserEarth record types are available through the API.
Comments, Ratings and Relationships to other records will not be available, nor will access to WiserEarth member profiles or their activity. All APIs will be 'Read Only'. In the future we expect to provide 'Write' access to trusted data partners upon request.
What kind of API will WiserEarth be providing?
The WiserEarth API is RESTful and outputs xml data in response to a request that contains the API key and a signature created by concatenating the secret code (assigned to you when you create your API key) with the parameters.
Example API request to retrieve a solution in PHP:
$apiKey = '670694205349ed6735de86557081cc0b';
$secret = '85ebb64263b2ea4acc96b40853414e65';
$solutionMasterid = '800f18f66ac105ba42b83b781e7bfba5';
$sig = md5('masterid'.$solutionMasterid.$secret);
$url = 'http://www.wiserearth.org/solutions/'.$solutionMasterid.'?sig='.$sig.'&key='.$apiKey;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$solutionXml = curl_exec($ch);
curl_close($ch);
Example API request to retrieve a solution in Ruby:
@apiKey = '670694205349ed6735de86557081cc0b'
@secret = '85ebb64263b2ea4acc96b40853414e65'
@solutionMasterid = '800f18f66ac105ba42b83b781e7bfba5'
@sig = Digest::MD5.hexdigest('masterid'+@solutionMasterid+@secret)
$url = open('http://www.wiserearth.org/solutions/'+@solutionMasterid+'?sig='+@sig+'&key='+@apiKey)
@solutionXml = uri.read
The $/@solutionXml will contain the following xml output (Note that parts of the output are replaced with '...' to help you easily see the structure of the response):
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok" version="1.0">
<solution href="http://www.wiserearth.org/solution/view/800f18f66ac105ba42b83b781e7bfba5"
Name="Empathy skills for US government officials"
Tagline="Teach empathy in the US - vote now"
Date_Published="2008-12-27"
Website="http://www.change.org/ideas/view/bridging_the_empathy_gap_-_yes_we_can"
Keywords="govt learn peace skills"
Language="English"
Created="2008-12-27 03:54:44"
Updated="2009-02-26 12:54:27"
Avatar="http://www.wiserearth.org/images/logos/solution-default-100.jpg"
Average_Rating="5.0000"
Number_Of_Ratings="1">
<AuthorList/>
<PublisherList/>
<Contact_PersonList>
<Contact_Person name="Priscila Siu(Priscila)"/>
</Contact_PersonList>
<AreasOfFocusList/>
<CommentList>
<Comment user="cnvcgcc"
time="2009-01-12 00:57:09"
rating="5"><![CDATA[These skills can affect the way governments interact ... people worldwide.]]></Comment>
</CommentList>
<FileList/>
<ReviewList/>
<SpecialTextList>
<Problem><![CDATA[Mismanaged conflict can produce erosion of trust...war. ]]></Problem>
<Action><![CDATA[Implement an ... and shared understanding <br />]]></Action>
<Results><![CDATA[<p>*Bridge diverse ideological divides</p> <p>*Develop policies ...</p>]]></Results>
<Limitations><![CDATA[<p><strong>Voting dateline...non-violence</p>]]></Limitations>
<WhenToUse/>
<WhatToDo/>
<Tips/>
<EquipmentAndSupplies/>
<Assessment/>
<RelatedResources/>
</SpecialTextList>
<CustomTaxonomyList/>
<ReviewGroupList/>
<NetworkInfo>
<Consultants/>
<Practitioners/>
<Funders/>
</NetworkInfo>
</solution>
</rsp>
The API will also provide access to the WiserEarth search. For example, to search for solutions in which the language is English, you would make the following request:
http://www.wiserearth.org/solutions/api_search?language=EN&sig=<signature>&key=<apiKey>
Who can use the API?
WiserEarth is provided under a Creative Commons Attribution-Noncommercial 3.0 License. This allows you to share or remix the content as long as you attribute WiserEarth as your source and use the information for noncommercial purposes (i.e. you may not sell it). As long as you stay within the framework of this copyright license anyone can use the API. WiserEarth administrators reserve the right to restrict access to the API for non compliance with the Terms of Use of the site. Each API user is limited in the number of calls their application can make to the WiserEarth database. This is to preserve optimal performance of the system.
How do I properly attribute WiserEarth under the Creative Commons Licence?
| Options | When to Use | HTML to Paste |
|
|
Full Webpages | <a title="Powered by WiserEarth" href="http://www.wiserearth.org" target="_blank"><img class="wiser" src="http://www.wiserearth.org/uploads/article/7b8548f1433a87584fb80484085a6e92/med_poweredbywiserearthlarge.png" alt="Powered by WiserEarth" /></a> |
|
|
Blogs / Widgets | <a title="Powered by WiserEarth" href="http://www.wiserearth.org" target="_blank"><img class="wiser" style="float: left;" src="http://www.wiserearth.org/uploads/article/7b8548f1433a87584fb80484085a6e92/med_poweredbywiserearth.png" alt="Powered by WiserEarth" /></a> |
| Powered by WiserEarth | Text Only |
<font face="arial,helvetica,sans-serif" size="3"><a style="color:#A6C121" href="http://www.wiserearth.org">Powered by WiserEarth</a></font> |
How do I get an API Key?
First, you need to become a WiserEarth member (Join here) and then go to an API Key creation page. Select which APIs you wish to use and click 'Save'.
Where can I find the API documentation?
All documentation is available in the WiserEarth API Developers group. You can read any documents but if you want to leave a comment or pose a question you will need to become a WiserEarth member by joining here.
Can you help me implement the API on our platform or service?
We would be happy to help you with advice and suggestions on how to implement the API. We suggest you join the WiserEarth API Developers group to get the latest information from the community. However, please expect to write your own code specific to your platform and situation.
How much of the API has been completed?
There are two sets of functionality offered as part of the API project:
- Administrative: If you are a WiserEarth administrator, you will be able to monitor, throttle, and search activity of API users. You will also be able to restrict or broaden access to users. All the requirements of the administrative controls have been completed.
- User: You can currently create an API key for yourself, activate API to access solutions and/or organizations, and start using the API with your key and secret code. While these features are completed, we are still working on the documentation to help guide you through the steps of retrieving data. In addition, we are working on increasing the coverage of the data provided through the API. For example, the search API for organizations, groups, resources, jobs, events is in the works.
When will the API be launched?
The API is launched as of June 2009, additional functionality is being developed during the remainder of the year.
Can I donate to get the API finished?
Yes, you can go to http://openwiser.org/ to provide your financial support. The WiserEarth community is raised $10,000 to complete the first and second stages of the API.
