Skip to content
Guido Krömer edited this page Jan 27, 2014 · 9 revisions

RESTful API

The CacoCloud backend is a rich RESTful API providing all functionality needed for the AngularJS based frontend and further frontends like a Android or iOS Client… . Existing fribi.js based tests ensures the backward compatibility.

Authentication

The API uses http://en.wikipedia.org/wiki/Basic_access_authentication) which makes accessing the API as easy as possible, but it this means you should run CacoCloud only with HTTPS!

Versioning

The current api version is 1, each example request in this document is build against version 1.

JSON

The API speaks JSON, requests with payload like POST or PUT and each REQUEST is a JSON document. Each response has the same structure, the status field is equal to the HTTP status code, the response property contains the response object or array:

{
  "status": 200,
  "response": …
}