Skip to main content

Try API Online

You can directly test the Aqara AIOT API online from the API documentation, making it convenient to test and verify API behavior. This article guides you through how to try the API online.

Before You Begin​

Before you begin, make sure you have prepared the following:

  • You have created an application on the Aqara Developer Platform and obtained Appid and Keyid.
  • You can generate the request Sign. For details, read Signature Generation Rules.
  • You have prepared Nonce (random string, should be different for each request) and Time (request timestamp in milliseconds).
  • If the endpoint requires authorized access, you also have Accesstoken.

How to Use​

  1. Select the API you want to test and click its name to view the documentation.

    View API Documentation

  2. On the right side of the documentation, find the Request area and click the Edit button next to Base URL.

    Click the Edit button

  3. At this point, the host field will appear below. Please select the Aqara Open Platform API server domain, such as https://open-cn.aqara.com, https://open-usa.aqara.com, etc. For available server region domains, refer to Getting Started with the AIOT API - Base URL.

    The AIOT API Base URL format is {host}/v4.0/open/api.

    Enter AIOT API server address

  4. In the Header parameters area, fill in Appid, Keyid, Nonce, Time, and Sign.

    Enter required request Header parameters

    In addition to the required header parameters, click the Show optional parameters button to view the optional header parameters.

    If the interface requires authorized access, you also need to fill in Accesstoken; if you need to specify the return language, you can fill in Lang.

    Enter optional request Header parameters

  5. (Optional) If the endpoint requires query parameters or a request body, continue configuring them in the Request area. For example:

  6. After completing the configuration, click Send API Request to debug the API online.

    Send Request

  7. After the request is sent, you can view the returned results in real time in the Response area below, including the HTTP status code, business code, and detailed response content.