ClimaCell Postman Collection

This quickstart is a step-by-step guide that will get you up and running with Postman and the ClimaCell Postman Collection.

If you are looking for a more in-depth guide and reference for the ClimaCell API, please refer to the ClimaCell API documentation.

Getting started

Follow these steps to quickly get started with the ClimaCell API:

1. Sign up with ClimaCell to get a set of API keys that are required for interacting with the API.
2. Download and install the Postman app
3. Import "ClimaCell Postman Collection" file or click the button below to install the ClimaCell Postman collection!
4. Import "ClimaCell Production Environment" and add your apikey that you grabbed from our Development Section
5. Change the query/path/body parameters by going to the "Pre-request Script" tab and modifying them
6. Click "Send"

Collection endpoints

The following collection is a fully-featured set of pre-filled requests that allow you to test the ClimacCell API, and visualize the responses in a friendly format.

• Timeline (GET/POST)
• Events (GET/POST)
• Route (POST)
• Map › Tile (GET)
• Locations
• Insights
• Alerts

Useful Tools

JSON to CSV can be used to transform a timeline to an CSV - just make sure to flatten the values before using the one-liner js code below and change RESPONSE to the one you got from our API.

(RESPONSE).data.timelines[0].intervals.map(obj => Object.assign({}, ...function _flatten(o) { return [].concat(...Object.keys(o).map(k => typeof o[k] === 'object' ? _flatten(o[k]) : ({[k]: o[k]})))}(obj)))

Plotly Chart Studio can be used to plot the data points. Simply convert a response to .csv (as mentioned above), import, inspect and share.

Webhook Tester can be used for receiving webhook calls. Generate a webhook url on this site and use that url in the developers section to get alert notifications.

Contribute

You can contribute to this project by forking the repo and following the setup steps to import those files. When you've made your contributions in Postman editor, use the File | Export to overwrite the file in your forked branch. Then simply submit the forked branch as a PR back to this repo.