Utilize API and Webhook

Thanks for choosing Milesight Development Platform! In this place, we will guide you through the major steps to help you integrate platform with third-party applications quickly.

Video Tutorials

Step 1. Enable an Application

To make API calls with the Milesight Development Platform, you need to create an Organization first, which will automatically generate a corresponding Application. Each Application is equipped with a unique set of authentication information to obtain an Access Token for API interactions, facilitating tasks such as adding, managing, and configuring devices.

For more information, see Application Overview and Disable or Enable an Application.

Step 2. Add Device to Application

Milesight Development Platform supports to add demo devices or real devices to application for quick test of API and webhook.

  1. In the Application Devices tab, move to Add Device button, select Add Virtual Device.

  2. Check the box of the product model, select the profile version or TSL version, click OK.

For more information, see Add Device to Application.

Step 3. Utilize API for integration and development

Milesight Development Platform provides APIs for two main features:
  • Device management: Add, manage and configure device.
  • RPS management: Query and specify the Profile URL for RPS, and manage RPS records.

For more information, see Milesight Development Platform API Overview.

  1. In the OpenAPI Debugging tab, select the OpenAPI version and the API which need to test.
    Note:
    • The OpenAPI can also be downloaded and imported to other API tool like Postman.
    • When you test the API with other API tool or application, it is necessary to Get an Access Token.
  2. Type the required parameters in the Debug Panel and click Send. The details of API and parameters please refer to API Interface List.

Step 4. Get real-time notifications via Webhook

Milesight Development Platform supports to set up webhook event notifications for third-party applications to get real-time notifications when the device reports data to Milesight Development Platform.
For more information, see Event Notification Overview.
  1. In the Application Settings tab, enable the Webhook option to subscribe Webhook events.

    1. In the Callback URI section, click Add.
    2. Enter the webhook callback URI for receiving event notifications.
    3. Click Test to check if the webhook is working properly.

      A test notification will be sent to all the Webhook callback URI you entered.

  2. Click Device Debug Panel icon at the bottom right corner of this application.

  3. Generate the simulate report as required.

    1. Select the device to simulate the report.
    2. In the Report tab, select the report type.
    3. Select one data item or multiple data items to report.
      Note: if you select multiple items, click Batch Report button to generate one message to include all selected items.
    4. Click Random Report or Custom Report to send the report.