Modio API

Modio API

The Modio API provides access to current and historical data and configuration of connected devices.

The API is RESTful and stateless. It is implemented over HTTPS and uses JSON for data representation.


TLS client certificates are used for authentication in the API.

The subject of the certificate will determine what permissions the API provides for reading data and making configuration changes.

API users will be provided with a certificate, or they may arrange to issue automated certificate signing requests to our CA.

Getting a cert

Create a python3 virtualenv:

$ python3 -m virtualenv venv
$ source venv/bin/activate

Ensure you have openssl installed:

$ openssl version

Install the caramel client:

$ pip install caramel-client

Download the ca cert:

$ curl -O

Request the certificate from

$ caramel-client test_certificate_please_ignore

Wait for the request to be signed.

Signing a request is a manual process where we verify who you are and that you requested this certificate, as well as giving you access to data in the backend. For this step to complete, you will need to contact us to verify your identity.

Putting it all together:

python3 -m virtualenv venv
source venv/bin/activate
pip install caramel-client
curl -O
caramel-client test_certificate_please_ignore