=Overview == REST API documentation == There are two types of API calls: * Fully RESTful Ressources and Collections (the default), addressed using "nouns"* Helpers, commands and actions, addressed using "verbs" With this we are following [https://blog.apigee.com/detail/restful_api_design_what_about_responses_that_dont_involve_resources/ a pragmatic API design].
=== Base URI ===
The RESTful web service has to be accessible via a secure HTTP (HTTPS) base URI, for instance <code>https://api.example.com/v1</code>.
The service validates all input it receives from a client and returns a <code>422</code> (Unprocessable Entity) HTTP [[#Error_codes_and_responses|error code with a descriptive error object]].
=== Auth action ===
To give a client the possibility of verifying username and password, a pseudo-ressource is provided, the only method implemented is the GET.
==== Auth retrieval (GET) ====
===== Auth retrieval (GET) example =====