The Consibio Cloud REST API v2 enables easy access to data stored in Consibio Cloud. All endpoints in the API is documented in the OpenAPI Specification (OAS) hosted here: https://api.v2.consibio.cloud/api-docs/
If you don't have any Consibio devices yet but still want to test integration with our API you can do it using a Demo Project with simulated data. It is quite easy to set that up! Just follow the steps below.
Step-by-step
-
Sign up on Consibio Cloud with a new user
Signup on Consibio Cloud (https://consibio.cloud/) with the email, that should be used for API authentication (ie. a service account). You will be asked to verify the email, so it should be an email account that you have access to. If you need help signing up, you can start here: How do I create a new user in Consibio Cloud?.
-
Sign in to your account in the browser
After signing up and validating the email address, go to https://consibio.cloud/ and login with the new account.
-
Open the automatically generated demo project
When signing in for the first time, a demo project with mock data will be automatically created for you. Click on it in the project overview:
-
Get the project id.
You will now be brought to the dashboard of the new project. Here you can see mock data of a simulated temperature curve.
You need to get the project ID for use with the REST API. After opening the demo project, you can see the unique project ID in the URL in the browser's address bar:
Copy this ID for use with the REST API.
-
Test the API!
Now you are all setup to test the API. The normal workflow when integrating with the API to retrieve telemetry datalogs is:
- Get a login token on the login endpoint using the credential of the newly created user:
POST: https://api.v2.consibio.cloud/login
- If the element ID's (ie. unique tag associated with each measurement parameter) are unknown: List the elements in the project for the given project ID (retrieved in step 4)
GET: https://api.v2.consibio.cloud/projects/{project_id}/elements
- Request datalogs for selected element IDs:
GET: /projects/{project_id}/datalog?elements={elementid1};{elementid2};&from_time={unix_timestamp_seconds}&to_time={unix_timestamp_seconds}
- Get a login token on the login endpoint using the credential of the newly created user: