How does it work?
Wakoopa provides a simple interface to access some of your data via
XML and JSON.
You can use this data to make your own widgets or integrate our service with other services.
If you have any questions or suggestions about our API don't hesitate to contact us.
What do we offer?
The following data is available: (click on the name to expand the entry)
- Your most used software
- URL:
http://api.wakoopa.com/<username>/most_used.xml
- Sample response:
<most-used type="array">
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</most-used>
- Your most recently used software
- URL:
http://api.wakoopa.com/<username>/recently_used.xml
- Sample response:
<recently-used type="array">
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</recently-used>
- Summary of your usage for the last day/week/month
- URL:
http://api.wakoopa.com/<username>/software_summary.xml?period=<period>
- <period> can be one of day, week or month
- Sample response:
<software-summary type="array">
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</software-summary>
- Newly used software
- URL:
http://api.wakoopa.com/<username>/newly_used.xml
- Sample response:
<newly-used type="array">
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</newly-used>
- Latest versions of your software
- URL:
http://api.wakoopa.com/<username>/versions.xml
- Sample response:
<versions type="array">
<version>
<created-at type="datetime">2007-08-21T19:56:34+02:00</created-at>
<id type="integer">154251</id>
<number>1.0.0.0</number>
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</version>
</versions>
- Comments on your profile
- Reviews you've written
- URL:
http://api.wakoopa.com/<username>/reviews.xml
- Sample response:
<reviews type="array">
<review>
<created-at type="datetime">2007-09-26T11:27:44+02:00</created-at>
<id type="integer">3143</id>
<rating type="integer">2</rating>
<text>Review text</text>
<software>
<active-seconds type="integer">1236482569</active-seconds>
<created-at type="datetime">2007-04-18T13:21:12+02:00</created-at>
<description>Software description</description>
<id type="integer">15</id>
<name>Software name</name>
<num-users type="integer">6264</num-users>
<updated-at type="datetime">2007-09-10T12:51:22+02:00</updated-at>
<url>http://software_url.com</url>
<complete-url>http://wakoopa.com/software/software_shortcut</complete-url>
<complete-icon-url>
http://static.wakoopa.com/images/software/software_id/picture.png
</complete-icon-url>
<complete-thumb-url>
http://static.wakoopa.com/images/software/software_id/thumb/picture.png
</complete-thumb-url>
<developer>
<id type="integer">95</id>
<name>Developer name</name>
<complete-url>http://wakoopa.com/developers/mozilla</complete-url>
</developer>
<category>
<description>Category description</description>
<id type="integer">1</id>
<name>Category name</name>
<complete-url>http://wakoopa.com/categories/category_shortcut</complete-url>
</category>
<os-types>
<os>mac</os>
<os>win</os>
</os-types>
</software>
</review>
</reviews>
- Your contacts on Wakoopa
- Teams you are a member of
- URL:
http://api.wakoopa.com/<username>/teams.xml
- Sample response:
<teams type="array">
<team>
<active-seconds type="integer">84093595</active-seconds>
<created-at type="datetime">2007-04-29T08:21:40+02:00</created-at>
<description>Sample description of a team</description>
<id type="integer">8</id>
<name>Name of the team</name>
<num-users type="integer">10</num-users>
<complete-url>http://wakoopa.com/teams/name</complete-url>
</team>
</teams>
Security and privacy
Access to your data through the API is restricted by your privacy settings. Providing a feedkey as an argument to your request will override these settings. An exception to this are applications you've chosen to show to nobody; they will never appear in any response.
Keeping your feedkey private is important to your own privacy. Have you accidently shared your feedkey with anyone, you can reset your key with the button below. Make you sure you are logged in to do this.
More on JSON
By default JSON-responses are wrapped in a callback function named wakoopaApi. This is the safest and easiest way to render your data as a nifty custom widget.
Example: print a simple list of your usage
<div id="widget"></div>
<script type="text/javascript">
function wakoopaApi(software) {
var html = ['<ul>'];
for (var i = 0; i < software.length; i++) {
var entry = software[i];
var img = '<img src="' + entry.complete_thumb_url + '" />';
html.push("<li>", img, entry.name, "</li>");
}
html.push("</ul>");
document.getElementById("widget").innerHTML = html.join("");
}
</script>
<script src="http://api.wakoopa.com/<username>/most_used.json"></script>
Optional arguments
At the moment there are two optional arguments you can add to the url:
- feedkey
For example: http://api.wakoopa.com/<username>/most_used.xml/<feedkey>
Your feedkey provides access to data you've chosen to be private. Read more about your feedkey in the privacy section.
- limit
For example: http://api.wakoopa.com/<username>/most_used.xml?limit=25
With this argument you can specify how much entries you want to retrieve. Should be an integer between 1 and 30.
- callback only json
For example: http://api.wakoopa.com/<username>/most_used.json?callback=myCustomCallback
Override the default callback function.