Getting started with CIM’s API
Welcome to the CIM developer portal. You'll find comprehensive guides and documentation to help you start integrating with CIM as quickly as possible, as well as support if you get stuck.
The CIM API can be used to integrate your data in CIM with any external system. The API closely follows REST semantics. This portal provides resources to learn and get started with the CIM API.
Additionally, you can access our Swagger spec files here:
| Endpoint | Swagger docs | What it covers |
|---|---|---|
| Core | https://api.cimenviro.com/swagger.json | Primary platform data and operations, including sites, levels, zones, meters, indoor environment, history. |
| Tickets | https://api.cimenviro.com/tickets/swagger.json | Alert and action tickets, related activity and metrics. |
| Notifications | https://api.cimenviro.com/notifications/swagger.json | Event notifications via webhook subscriptions. |
How to view the docs in Swagger Editor
Download the JSON file and import into https://editor.swagger.io/
- Open the Swagger JSON in a new browser tab and save the JSON file (e.g. https://api.cimenviro.com/swagger.json)
- Open the Swagger Editor: https://editor.swagger.io/
- Select File → Import File and choose the .json file you saved in step 1
- The editor will render the interactive documentation in the right-hand pane.