Introduction to the REST API

For communication with client applications, Varda exposes an API following the REST architectural style. The API represents resources in JSON format and user authentication is done using HTTP Basic Authentication.

Start by going through the API manual. After that, read through the documentation for the individual resources.

Conformance with REST

Although Varda tries to follow REST in its API, there are certainly parts of the API that are not completely in the spirit of REST.

Todo: More text here, at least covering the following points:

  • JSON is not a hypertext format
  • Accepting a request body with GET
  • Todo