API reference
Using the API
Our API provides tools for integrating our services as part of your own business. We provide an API for all needed actions for effectively managing your configuration and accessing data.
All features are available as a REST API.
Accessing our API
Our API can be accessed using the following URL:
https://api.hypercell.ai
The alternative URL for the API is:
https://api.hypr.cl
Authentication
All requests to the API need to be authenticated using API credentials.
The API credentials, also known as a token, are passed along with the header of the request using a x-api-key variable.
API tokens can be found in the user interface, in the access control section.
API credentials can be configured with different levels of privileges.
API methods
In general, our API uses the following methods.
| Method | Description |
|---|---|
| GET | Fetch data or resource(s) |
| POST | Create a resource |
| PATCH | Modify a resource |
| DELETE | Delete a resource |
Data API endpoints
The Data API provides the following endpoints.
The core URL of all requests for accessing the Data API is:
https://api.hypercell.ai/data/v7
| Method | Endpoint URL | Description |
|---|---|---|
| GET | /minute | Fetch minute data for all sensors |
| GET | /minute/sensor/:sensorSerial | Fetch minute data for a specific sensor |
| GET | /minute/group/:groupId | Fetch minute data for a specific group |
| GET | /hourly | Fetch hourly data for all sensors |
| GET | /hourly/sensor/:sensorSerial | Fetch hourly data for a specific sensor |
| GET | /hourly/group/:groupId | Fetch hourly data for a specific group |
| GET | /daily | Fetch daily data for all sensors |
| GET | /daily/sensor/:sensorSerial | Fetch daily data for a specific sensor |
| GET | /daily/group/:groupId | Fetch daily data for a specific group |
| GET | /inbound | Fetch inbound route data |
| GET | /outbound | Fetch outbound route data |
Management API endpoints
The Management API provides the following endpoints.
The core URL of all requests for accessing the Management API is:
https://api.hypercell.ai/v7
| Method | Endpoint URL | Description |
|---|---|---|
| GET | /sensors | Fetch a list of all sensors |
| GET | /sensors/:sensorSerial | Fetch details of a specific sensor |
| PATCH | /sensors/:sensorSerial | Modify the settings of a sensor |
| GET | /calibrations | Fetch a list of all data profiles |
| POST | /calibrations | Create a new data profile |
| PATCH | /calibrations/:calibrationProfileId | Modify an existing data profile |
| DELETE | /calibrations/:calibrationProfileId | Delete an existing data profile |
| GET | /groups | Fetch a list of all groups |
| GET | /groups/:groupId | Fetch details of a specific group |
| POST | /groups | Create a new group |
| PATCH | /groups/:groupId | Modify an existing group |
| DELETE | /groups/:groupId | Delete an existing group |
| GET | /thresholds | Fetch a list of all thresholds |
| GET | /thresholds/:thresholdId | Fetch details of a specific threshold |
| POST | /thresholds | Create a new threshold |
| PATCH | /thresholds/:thresholdId | Modify an existing threshold |
| DELETE | /thresholds/:thresholdId | Delete an existing threshold |
| GET | /users | Fetch a list of all users |
| GET | /users/:userId | Fetch details of a specific user |
| POST | /users | Create a new user |
| PATCH | /users/:userId | Modify an existing user |
| DELETE | /users/:userId | Delete an existing user |
| GET | /apikeys | Fetch a list of all API credentials |
| GET | /apikeys/:apiKeyId | Fetch details of a specific API credential |
| POST | /apikeys | Create a new API credential |
| PATCH | /apikeys/:apiKeyId | Modify an existing API credential |
| DELETE | /apikeys/:apiKeyId | Delete an existing API credential |