The Kaleidosim cloud API provides methods to programmatically, or automatically, control the cloud. We offer methods that can be used for simple automation scripts right through to completely integrating KaleidoSim cloud into your existing software.
The API implements a simple REST interface, which means you can use it with any programming language you choose. We also offer Open API support which allows you to quickly automatically generate code with Swagger, Orval, etc. which will speed along your developments.
In the sections below you can find information about software examples of how to use our
API. Also, we describe how you can access our online documentation for the API.
Support contact #
If you need support with the example projects, or you need additional information please
contact: [email protected].
Software examples #
We are software developers too, so we understand that an example speaks more than 100s of pages of documentation. In the sections below, you can find complete examples for accessing our API from Python and JavaScript languages. Bear in mind that our REST API can be used from any programming language you choose. E.g. Even a bash script with wget is possible.
If you would prefer you can jump into the documentation first in the API Documentation section.
Before considering writing a lot of boilerplate code for accessing the API, we recommend investigating code generation using OpenApi. You can always get our latest OpenAPI file directly from https://api.kaleidosim.com/openapi.json. We like to use Orval (https://orval.dev/) at Kaledosim when we generate applications accessing our API. Also take a look at https://swagger.io/. Please feel free to reach out to us at [email protected] and have a quick chat with us before getting started, perhaps we can save you some time?
