Overview
A brief overview of the StellaDoradus API
Third-Party Integration API Overview
The Integration API is a set of HTTP endpoints that can be used to:
- Retrieve information about connected devices
- Configure selected device parameters
- Turn device bands on and off
- Send commands to devices, such as reboot or recalibrate
Please refer to the API User Guide for a detailed presentation of the API and the technical steps required to use it.
The Terms and Conditions document describes the legal framework of using the Third-Party Integration API by our customers. By proceeding further you acknowledge that you have read and accepted these terms.
Service Details
The Integration API is available to our customers on request. The platform administrator has to enable the necessary permissions and grant the customer with API key and secure credentials.
Permission to use Third-Party Integration API does not imply unlimited access to all the data and functionality available through the web platform. The functionality available to each customer might vary, depending on customer needs and contractual agreements. Only the functionality necessary for implementing the customer’s specific integration scenario will be made available.
The API is only available to devices using the ethernet connection.
Each device is allowed 10K messages per month per device.
The API can change the message frequency to 1s, 10s, 1m, or 10m
Integration API is offered as paid service, separate from web platform access. Ask the reseller for the price estimate. Pricing is determined for each customer individually. It will depend on the number of enabled actions and data points, the expected data traffic and the additional system load, and other technical considerations.
Available Functionality
The following functionality is available through Third-Party Integration API (subject to limitations discussed in the previous chapter):
Data Available in Device Status Updates
Device Status dataset includes selected values describing vital parameters of the device:
Device Identification
| Field | Details |
|---|---|
| serialNumber | Device serial number |
| version | Data protocol version |
| type | Device type |
| model | Device model |
| portCount | Number of connection ports |
| bands | Available bands |
| firmwareVersion | Firmware version |
| location | Internal location of the device |
Device connection status
| Field | Details |
|---|---|
| status | Current connection status: unknown,lost,never-connected,heartbeat,online,error |
| messageFrequency | Frequency at which the device sends its status to the platform |
| rebalanceFrequency | Frequency at which the device runs rebalancing sequence, in seconds |
| description | Human-friendly description of the connection status, eg. ‘Lost 5d 20h ago’ |
Device health
| Field | Details |
|---|---|
| temperature | PCB temperature, °C |
Device band
| Field | Details |
|---|---|
| identifier | Band identifier: 07,08,09,18,21,26 |
| frequency | Band frequency, Hz |
| label | Band label |
| status | Band status: offline, online |
| isOnline | Indicates whether the band is currently online |
| isAGC | Indicates whether neartower_dw is greater than zero on the band |
| isOverPower | Indicates power surge on the band |
| isFeedback | Indicates feedback on the band (oscillation) |
| isShutdownManually | Indicates that the band has been shut down manually by the operator |
| isShutdownAuto | Automatic Shutdown of band due to high downlink power. |
| isUplink | Indicates ongoing uplink activity on the band |
| ledCount | Band signal strength, 1..5 |
| values | Additional technical parameters of the band: |
| values.uplinkPower | Uplink power received by the repeater |
| values.downlinkPower | Downlink power received by the repeater |
| values.AGC | Downlink AGC for when you are near a base station |
| values.uplinkFastAGC | Uplink AGC for when you are near a base station |
| values.bandUsage | Percentage use of each band calculated from uplink switch on |
| values.clamp | Extra attenuation added for when there is an oscillation |
| values.downlinkReducedGain | Uplink reduced gain |
| values.uplinkReducedGain | Downlink reduced gain |
Timings
| Field | Details |
|---|---|
| createdAt | ISO date/time when device status has been received |
| timestamp | Numeric timestamp when device status has been received |
| uptime | Device uptime, in seconds |
Device Commands
Several commands can be issued to a device using the Third-Party Integration API:
- Recalibrate the device
- Reboot the device
The commands will only be executed if the device is currently online.
Device Parameters
The following device parameters can be controlled using the Third-Party Integration API:
- Device bands can be turned on and off
New parameters can be assigned to devices, even if the device is currently not online. The new values will be applied immediately when the device comes online and retrieves the new parameters from the platform.
Other Functionality
Third-Party Integration API can be easily extended according to the customers’ needs. If you need new functionality which isn’t yet available in the API, please submit an inquiry to your reseller, describing the use case in detail.