Version 8, last updated by Moult at November 23, 2010 13:42 UTC
Eadrax has a REST API which follows OpenDesktop's OCS (Open Collaboration Services) spec. The currently implemented version is version 1.6. If you want to develop an app using the API, the first step is to check out the spec.
Unfortunately due to some spec limitations (things are improving slowly) our implementation differs a bit from the spec in that obviously not all services are implemented, and not all of their methods are either, and only some parameters are required, and some aren't. Below is a list of how things work (if it isn't listed, it's not there):
| Service | Method | Notes |
| CONFIG | config | Works per spec. |
| PERSON | check | Works per spec. |
| add | Login only accepts username, not API key. Firstname, lastname and email don't exist. 105 and 106 don't exist. | |
| search | Only name, page, and pagesize exist. Name doesn't only search username, but also searches emails and user descriptions. Results are limited to 50 maximum, so 102 doesn't exist. Returns personid and gender. | |
| get | 102 doesn't exist. Returns personid, email, gender, description, avatarpicfound and avatarpic. | |
| get self | Same as get. | |
| ACTIVITY | get | Type categories are not reliable. Returns personid, avatarpic (does not auto-fill nopic urls), timestamp (different format), type, message (has html), link. |
| CONTENT | categories | Works per spec. |
| subcategories | Brand new. It's basically the same as categories with added argument, eg: v1/content/subcategories/self, where self is either self for auth'ed user, or a username of another user. Returns WIPUP projects owned by a user (including the special Uncategorised project) with id, name, category, categoryid, and personid. | |
| list | Also supports subcategories as an argument. External, distribution, license, or sortmode (defaults to new) doesn't exist. Returns id, name, changed, categoryid, category (to replace typeid and typename respectively), subcategoryid, subcategory (like typeid and typename, but for subcategories), personid, profilepage, score, comments, preview1, previewpic1. | |
| get | Same as list for what it returns, but it will additionally return description, downloads, and may return previewpic2-5, downloadlink1-5, and downloadtype1-5. | |
| vote | Must be auth'ed. All vote values count as positive. | |
| add | Arguments are name, type (uses subcategoriesid, not categoriesid), description, and downloadlink1-5. downloadlinks must be full path to file - it will be uploaded directly, not hotlinked as the spec shows. Additionally you may supply syntax and pastebin arguments which are new. | |
| edit | Same as add. | |
| delete content entry | Works per spec. | |
| COMMENTS | get | Works per spec. |
| add | Content2, parent and subject don't exist. |