API
The Qvaq API is still in beta and changes might be done without notice. There may also be bugs that we'd love to hear about in the qvaq api group.
To use the API you will need a API-KEY, you can request a key here. You need to provide your API-KEY in every request you make.
Introduction
All methods in the api is called via the http-protocol and all methods are located at services.qvaq.com.
Here is a simple example on how to get the latest 50 messages submitted in the qvaq-group:
http://services.qvaq.com/getMessages?groupname=qvaq&limit=50&format=xml&key=4fsd3aweva34398sfe98u98u3sfsaoiu
Methods
These are the methods that are currently supported by the api.
getMessage?id=1&format=xml
getMessages?groupname=qvaq&username=murtlest&start=10&limit=20&format=xml
getUser?username=murtlest&format=xml
getGroupUsers?groupname=qvaq&format=xml
getUsersGroups?username=murtlest&format=xml
getGroup?groupname=qvaq&format=xml
getGroups?query=qva*&start=0&limit=20&format=xml
createGroup?groupname=qvaq&language=swe&format=xml
joinGroup?groupname=qvaq&format=xml
leaveGroup?groupname=qvaq&format=xml
postMessage?groupname=qvaq&message=testing the api&format=xml
All method-calls starts with http://services.qvaq.com/ and ends with &format=xml&key=4fsd3aweva34398sfe98u98u3sfsaoiu (replace the key with your personal API-KEY).
Formats
Currently you can choose to get the returned data in two formats, xml or json. You specify you prefered format with the format parameter. Possible values are "xml" and "json", xml is default.
Authentication
Some methods, for example joining a group, will require the user to be authenticated with a username and password. Currently the only authentication method we support is basic authentication.
Error Codes
The methods can return a number of different error codes if the call fails. Often the response includes an explanation of what went wrong, however, here is a list of possible error codes.
401 Unauthorized
Either you have not provided any username or password yet or the username/password was incorrect.
404 Not Found
This error might occure when you for example try to get a user with a username that doesn't exists or a group that doesn't exist. However, it might also occure if you try to use a method that doesn't exist.
Ajax
Remember that cross-domain calls are not supported by all browsers. If you want to make an ajax-app using the api you need to proxy your requests.