Conventions
Terms
The following terms are used throughout this documentation:
- client / client application
- An HTTP client requesting resources using the methods provided by this API.
- user
- The entity (person) on whose behalf the client application performs requests. The user identifies itself to the application (and thus the API) using its login credentials (login and password).
- resource
- Any data record that the client application wishes to access on behalf of the user.
- authentication
- Refers to the process of requesting an access token for use in subsequent requests.
- authorization
- Refers to the the act of providing a previously issued access token in a request for a resource.
Response style
e.g. Status 200 "OK" for listing certain galleries
{
"status": 200,
"status_message": "OK",
"info": "",
"data": {"array":[{"id":61294,"name":"Gallery1","folder_id":223},
{"id":61378,"name":"GalleryLeer","folder_id":223},
{"id":61362,"name":"SuperGalleryX","folder_id":223},
{"id":61422,"name":"GalleryNeu","folder_id":223}]}
}
e.g. Status 422 for a malformed request
{
"status": 422,
"status_message": "Unprocessable Entity",
"error": {"base":["Children not allowed for this folder"]}
}
Examples
All examples in this documentation represent HTTP messages (requests and responses).
However, to improve the clarity of the examples, common headers are omitted. Especially the "Host" header is never shown, but MUST be provided for all requests, as it is required by HTTP 1.1 (per RFC 2616, section 14.23).