API docs by Redocly

Device Service - Getting Started

Download OpenAPI specification:Download

Getting Started

The Device Service simplifies the process of provisioning and managing devices across various communication and alarm services. Follow the steps below to get started:

At Your Side:

  1. Generate API Keys

    If using APIs for device provisioning, generate API keys for API access authentication. This allows a secure and authenticated access to the provisioning API.

  2. Prepare a List of Devices

    Compile a list of devices to be provisioned, including the device ID and any required configuration details.

  3. Provision Device IDs and Credentials

    Set up the devices with their configured device IDs and credentials, ensuring they are ready to connect with iotcomms.io's services.

Provisioning the Service:

  1. Provision Devices via Web Interface or API

    Use the iotcomms.io web interface or provisioning API to set up each device. Here, the device ID, credentials, and any applicable service-specific configurations can be assigned for seamless integration.

  2. SIP Device Addressing

    For SIP devices, a unique SIP address will be generated in the format sip: <deviceid>@<domain>. Here, <deviceid> represents the provisioned ID for the device, and <domain> is the tenant domain name associated with the customer, ensuring correct routing and connectivity.

Testing the Service:

To verify that devices have been successfully provisioned and connected to the iotcomms.io services:

  1. Connect a Provisioned Device

    For example, connect a SIP device that has been provisioned with its designated credentials.

  2. Check the Logs

    In the developer portal, navigate to the "Logs" view. You should see a "SIP Register" request successfully received from the device.

  3. Verify Device Status

    In the "Device Management" view in the developer portal, confirm that the "status" icon for the device has turned green, indicating successful connection and readiness.

Following these steps will ensure that your devices are fully integrated and operational within the iotcomms.io ecosystem, providing a smooth onboarding and testing experience.