Skip to main content

Overview

Learn about the resources Aqara provides for your further development.

Developer Resources

Choose the Right Integration Path First

Aqara currently provides two API tracks, each targeting a different environment and requiring different prerequisites. Before diving into the docs, first determine whether you need Cloud API or Studio API.

API TypeTypical ScenarioWhat You Need Before You Start
Cloud APIIntegrating with Aqara cloud platform capabilitiesGo to the Aqara Developer Platform, create an app, obtain Appid and Keyid, and prepare authorization and signature generation.
Local API for StudioIntegrating with data and control capabilities inside Aqara StudioPrepare an accessible Aqara Studio environment, along with its service address, token, and relevant project or device data.

API Documentation

This section will gradually include multiple API documentation sets for different product capabilities and integration scenarios. The currently available API docs help you understand API scope, request methods, authentication requirements, parameter structures, response formats, and setup prerequisites.

The API docs currently available are listed below:

SDKs

In addition to API documentation, this section will also continue to include SDKs and related integration examples to help you complete integration and debugging more efficiently.

Online Debugging and Validation

For API docs that support interactive testing, you can validate request parameters and basic configuration directly in the documentation. Because Cloud API and Local API for Studio target different environments, the authentication approach and service endpoint configuration you need to verify will also differ.