Third-Party Integration API

This repository contains documentation and code examples for implementing integration of iRepeater dashboards with third-party systems through Integration API.

Integration API exposes HTTP endpoints which can be used to:

  • Retrieve information about connected devices
  • Configure device parameters such as enabled bands
  • Send commands to devices such as reboot or recalibrate

For detailed explanation of the API and technical steps required to connect to it, refer to the API User Guide.

Before proceeding with the integration, please make sure to have read and understand our Terms and Conditions. By proceeding further you acknowledge that you have read and accepted these terms.

Availability

To be able to use the Integration API you need to obtain API key and secure credentials. For this, please contact your reseller.

Functionality

The following endpoints are currently available:

  • Security endpoint, used to initiate secure session with the Integration API
  • Devices endpoint, used to obtain information about devices, configure devices and send commands

Security Endpoint

Security endpoint allows executing the following actions:

  • Login: used to establish secure integration session
  • Logout: used to close the finished integration session

Devices Endpoint

Devices endpoint exposes the following data:

  • Device metadata: general information about device such as type, model, software and hardware version, supported bands, device location etc.
  • Device status: most recent status reported by the device and its operational parameters, such as bands currently turned on, attenuation values, PCB temperature etc.

Device status can be retrieved in two ways:

  1. By periodic querying the most recent status
  2. By subscribing to push notifications using Web Sockets

The former is sufficient for small fleets and simple integrations where there’s no need for one-second accuracy of device status. Being resource-demanding, it is subject to strict throttling.

The latter is used for large fleets and integrations where device status needs to be reported instantly, as soon as it arrives from the device. Read further in the tutorial to learn more about status notifications.

Devices endpoint allows remotely executing the following actions on the device:

  • Ping the device, to see whether it’s alive
  • Recalibrate the device
  • Reboot the device
  • Turn device bands on and off
  • View device parameters

Permissions

Every data point and every action has to be explicitly permitted by system administrator. For each customer only the actually required functionality will be enabled. Attempts to access endpoints and functionality which has not been permitted will end with HTTP 401 Unauthorized errors.

Repeated calls to unauthorized endpoints will cause integration account to be automatically blocked and all API access revoked.