API Doc
Version: 1.1 beta
The API is REST inspired.
Please note that this is still beta software. The api may change in the future.
The api is accessible via our api servers. Examples are http://api.opendesktop.org http://api.gtk-apps.org or http://api.kde-look.org.
Please note that you can only access the content from a specific website via the corresponding api website. So if you want to access the content from, for example GNOME-Look.org you have to use api.gnome-look.org.
All names aren't allowed to contain spaces, slashes or colons.
Please note that we use a caching system to reduce the database load. It is possible that you get the newest contents with a small time delay.
Authentication is done via you user account. If you don't want to use your useracount you can send us the IP adress of your server and we can put you on a whitelist.
Methods:
CATEGORIES
Get a list of all available content categories.
Only authenticated users are allowed to access this method. Authentication is done by sending a Basic HTTP Authorisation header.
Syntax: /V1/CATEGORIES/
Result: categories xml
Example: http://frank:password@api.opendesktop.org/V1/CATEGORIES
LIST
Gets a list of a specific set of contents.
Only authenticated users are allowed to access this method. Authentication is done by sending a Basic HTTP Authorisation header.
Syntax: /V1/LIST/<categories>/<sortmode>/<page>
Arguments: categories - Ids of the requested category ids seperated by "x".
Arguments: sortmodes - The sortmode of the list. Possible values are: "new" - newest first , "alpha" - alphabetical, "high" - highest rated, "down" - most downloads
Arguments: page - The content page. Every page has max 10 entries. The first page is 0, the second is 1, ...
Result: content xml
Example: http://frank:password@api.opendesktop.org/V1/LIST/1x2x3x4/new/1
Gets the second page of the list of the newest contents from categories 1,2,3 and 4
GET
Read content data of one specific content.
Only authenticated users are allowed to access this method. Authentication is done by sending a Basic HTTP Authorisation header.
Syntax: /V1/GET/<contentid>/
Arguments: contentid - Id of a content
Result: content xml
Example: http://frank:password@api.opendesktop.org/V1/GET/12345
VOTE
Vote for one specific content.
Syntax: /V1/VOTE/<contentid>/<vote>
Arguments: contentid - Id of a content
Arguments: vote - The vote. <good> or <bad>
Result: status xml
Example: http://api.opendesktop.org/V1/VOTE/12345/good
top