Any Caldera software can run concurrently on the same or multiple stations over a network.
Caldera REST API is a way to interact with Caldera services by exchanging data (in JSON format) via HTTP protocol, which is common on the web.
Warning
The Caldera Support team does not provide free consultation on using the API.
CalderaCare or GrandRIP MAX subscriber support only includes installing help and collecting feedback and requests. The REST API documentation is designed to be self-sufficient and constantly improved.
HTTP Requests
- GET: Fetch/get/gives a resource or a list of resources in the response body. If a list of resources is fetched, the total number of resources is included in the header caldera-total-results.
- HEAD: caldera-total-results in response headers but no "Body" answer. It is useful to save bandwidth when you only need to know how many services are registered but don't want the details.
- POST: Modifies an element or creates an element with more information.
- DELETE: Deletes an existing element.
Routes
The Routes are the URLs where data can be requested, the basic ones are about:
- /services: Caldera services (application backends) that are running and are available to request data
- /devices: Device data
- /jobs: Jobs data (can be RIP jobs, print jobs, cut jobs, or even spectrophotometer jobs)
Caldera REST API definition
The Caldera REST API definition, which includes details about endpoints, request types, and responses, is provided below in OpenAPI format.
We also provide you with different tools for consulting the definition and a Caldera Testing Interface.
The Swagger Editor is a free tool that lets you view and interact with REST API specifications written in the OpenAPI format using YAML.
Discover the Caldera REST API with Swagger:
| OpenAPI Spec (YAML) | Web tool to test | App to download |
Postman is a popular application for easily interacting with APIs.
The following collection in JSON format will help you get started and explore the Caldera REST API with Postman:
| Postman collection (JSON) | App to download |
This tool was developed for use with Caldera REST API v1.1.1, however, it is also compatible with more recent versions.
You can also use your web browser to trace HTTP requests. Below is a simple HTML interface developed by Caldera for testing the REST API.
| Caldera's Testing Interface |
Good to know
If something goes wrong, you can copy the debug trace displayed at the bottom of the page to share with the Support team.