Info
The Caldera REST API is a way to interact with Caldera services with the exchange of data (in JSON format) via HTTP protocol that is common for the web. You may also want to read:
September 2023 (pre-release)
Version 0.9.0
Features
|
New
|
Devices, Jobs, and Presets resources now have an "idents" property. |
|
New
|
The ink consumption of jobs is now added to the latest print journal event. |
|
New
|
Resources IDs are now base64url-encoded. |
June 2023
Version 0.7.2
Caution
The HTTP request GET /licenses is not implemented on this version.
Pre-conditions
- A license with CalderaCare is needed
- Servers must be started via CalderaRIP
- For file drivers, the output directory must be configured correctly.
- Presets must be configured via CalderaRIP
- The number of copies is in the preset for now
Known bugs
- The POST /services/:service/image is not functional on Mac
- The IDs are not working as described in API:
- ~port needs to be replaced by :0
- printer name needs to be suffixed by "Printer:"
- Note that they will be changed to non-meaningful classical ID in the next version to avoid such issues
Routes
|
New
|
GET /devices/:device/presets (list presets available for a device) |
|
New
|
POST /devices/:device/jobs (submit a new job on a device with Preset and Image references) |
|
New
|
POST /services/:service/image (add images to a service) |
Documentation
|
New
|
Official HelpDesk Section with documentation |
|
New
|
Official Postman collection |
June 2023
Version 0.7.1
Caution
The HTTP request GET /licenses is not implemented on this version.
Routes
|
New
|
GET /devices (all devices on all services) |
|
New
|
GET /jobs (all job information of all devices on all services) |
|
New
|
GET /services (local auto-discovery) |
|
New
|
POST/DEL /services (manually manage local and remote services) |
Features
|
New
|
Filtering and sorting on all routes |
|
New
|
HEAD versions on routes to get faster answers to count elements |
Documentation
|
New
|
Non-official Postman collection (see attachment below) |
|
New
|
Non-official temporary tutorial video |