JWS API (Joomla Web Service API) presents a simple way of creating a RESTful API using the Joomla! Framework and the new Unified Content Model. The current version of the API is 1.0 and developers can create directory-like applications with it.
Every object in the API is considered to be content and it has an unique ID. The properties of an object can be accessed by making requests at http://ws-api.cloudaccess.net/ws/www/OBJECT/ID.
At this moment the current version is a test one and it may have small issues. If you find any of them, please report them on https://github.com/stefanneculai/Web-service-API/issues.
The only supported output format so far is JSON, but in the future XML will also be available. The output format can be chosen by adding .json or .xml at the end of the resource path.
The HTTP methods supported are: GET, POST, PUT, DELETE. If your client doesn't support advanced methods such as PUT or DELETE you can make PUT or DELETE as a POST request and adding _method=HTTP_METHOD in the query.
The version of the API should be specified at the highest level scope (http://ws-api.cloudaccess.net/ws/www/v#) in the URL having a prefix v and an integer representing the version. For the moment, the only available and default version is v1.
By default the response code is 200 for successful result and 400 for failure. Passing the parameter suppress_response_codes=true will make all responses to have the the successful code 200. By default, failure returns an array of structures with information about the error occured containing code, message and more_info fields.