This document describes the API Level versions and the software development kits (SDKs) released with each version.
What is an API Level?
- An API Level is an integer that uniquely identifies the set of APIs that a mobile application SDK provides to mobile plug-ins. Each API Level includes a group of SDKs, and each SDK contains a collection of APIs.
- As platform SDKs evolve, new features and APIs are added. In rare cases, APIs are deprecated.
- The API Level concept was introduced to prevent incompatibility issues, such as crashes, when plug-ins built with new APIs run on older SDKs that do not include those APIs.
- As more APIs are exposed to plug-ins, the API Level on the developer platform increases. Each plug-in specifies a minimum required API Level.
- When a developer selects an API Level on the application development platform, the platform filters the list of available SDKs. After the developer selects the required SDKs, the platform then filters the list of available plug-ins based on the chosen API Level and SDKs.
For a mobile plug-in to be compatible with a mobile application, the application's API Level must be greater than or equal to the plug-in's API Level.
API Level 9
API Level 9 was released in May 2020 and includes 11 SDKs. This upgrade adds support for global multi-point access. You no longer need to specify a region during SDK initialization.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable user interface (UI). It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | Supports global multi-access point connection. |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | Supports global multi-access point connection. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | Supports global multi-access point connection. |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | None |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | Supports global push. |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, smart router provisioning, device-to-device provisioning, and device hot spot provisioning. | None |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | None |
| Thing Specification Language Model | The Thing Specification Language (TSL) Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | None |
| Bluetooth OTA | The Bluetooth Over-the-Air (OTA) SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | None |
API Level 8
API Level 8 was released in December 2019 and includes 11 SDKs. This upgrade adds support for multi-point access in regions outside the Chinese mainland and provides a push service. It also improves the application's network performance and unifies several functional interfaces to reduce integration costs.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | Supports multi-access point connection in regions outside the Chinese mainland. |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | Supports multi-access point connection in regions outside the Chinese mainland. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | Supports multi-access point connection in regions outside the Chinese mainland. |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | None |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | Supports push notifications in regions outside the Chinese mainland. |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, smart router provisioning, device-to-device provisioning, and device hot spot provisioning. | None |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | None |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | None |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | None |
API Level 7
API Level 7 was released in September 2019 and includes 11 SDKs. This upgrade adds support for the arm64-v8a architecture to meet Google Play marketplace requirements.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | None |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | None |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | None |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | Supports the arm64-v8a architecture. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, smart router provisioning, device-to-device provisioning, and device hot spot provisioning. | None |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | None |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | None |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | None |
API Level 6
API Level 6 was released in May 2019 and includes 11 SDKs. This upgrade primarily updates the cache policy for device data.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | None |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | None |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | None |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | Upgraded API Level to 6. Upgraded Router-external (routing cache policy changed to prioritize local cache). |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, smart router provisioning, device-to-device provisioning, and device hot spot provisioning. | Supports QR code provisioning. |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | Returns Breeze Bluetooth device activation data upon successful connection. |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | New Feature: Device shadow. |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | None |
API Level 5
API Level 5 was released in February 2019 and includes 11 SDKs. This upgrade adds support for provisioning through a device hot spot.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | None |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | New Feature: API request timeout setting. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | None |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | API Level value changed to 5. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, smart router provisioning, device-to-device provisioning, and device hot spot provisioning. | New Feature: Support for device hot spot provisioning. |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | None |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | None |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | None |
API Level 4
API Level 4 was released in November 2018 and includes 11 SDKs. This upgrade adds support for using Bluetooth capabilities in plug-ins and includes upgrades to related Bluetooth SDKs.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | None |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | None |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. |
|
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | Bug Fix: Fixed a crash that occurred when debugging plug-ins on Android 8.0. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | None |
| Network Provisioning | Lets you connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, and smart router provisioning. | None |
| Bluetooth | Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications, helping partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | None |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. Use it to develop device interfaces for viewing and controlling devices from a mobile phone. | New Feature: Support for Bluetooth devices in local communication. |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | Bug Fix: Fixed a compilation conflict in the iOS SDK caused by class names that were identical to those in other libraries. |
API Level 3
API Level 3 was released in May 2018 and includes 11 SDKs.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | Added support for internationalization (English language). |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | New Feature: Support for internationalization. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. |
|
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | Added support for zero-configuration loading of official plug-ins. Private plug-ins are not supported. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. |
|
| Network Provisioning | Allows you to connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, and smart router provisioning. |
|
| Bluetooth | The Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications and helps partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | New Feature: Added instrumentation. |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. You can use it to develop device interfaces for viewing and controlling devices from a mobile phone. | New Feature: Added support for gateway sub-devices in local communication. |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | New Feature: Adjusted the SDK code structure. The OTAHelper business logic class was removed from the SDK. |
API Level 2
API Level 2 was released in February 2018. This level includes 11 SDKs and builds on API Level 1 by adding five new SDKs: Unified Identity Authentication, Network Provisioning, Bluetooth, TSL Model, and Bluetooth OTA.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. It is based on the OAuth 2.0 protocol and lets you quickly integrate your own account system into your application. | New Feature: Added support for logging on with your own account. |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | New Feature: Added support for extended account authentication capabilities. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | New Feature: Optimized internal logic. |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | New Feature: Added support for alias and configuration features. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | None |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |
| Unified Identity Authentication | Provides a user identity authentication solution based on iotToken. It integrates with the Account and User SDK and the API Channel SDK to manage user identity credentials and authenticate API requests. | Initial release. |
| Network Provisioning | Allows you to connect Wi-Fi devices to a home router and discover connected devices on the local area network. Solutions include one-click broadcast provisioning (P2P), mobile hot spot provisioning, and smart router provisioning. | Initial release. |
| Bluetooth | The Breeze SDK is a mobile Bluetooth SDK that complies with standard specifications and helps partners quickly integrate Bluetooth features. Its main functions include device discovery and connection, device communication, encrypted transmission, and large data transmission. | Initial release. |
| Thing Specification Language Model | The TSL Model SDK provides the application-side TSL model, which includes properties, events, and services. You can use it to develop device interfaces for viewing and controlling devices from a mobile phone. | Initial release. |
| Bluetooth OTA | The Bluetooth OTA SDK provides an application-side solution for Bluetooth OTA services. It lets you upgrade Bluetooth device firmware and must be used with the Bluetooth SDK. | Initial release. |
API Level 1
API Level 1 was released in December 2017 and includes 6 SDKs.
| SDK Name | SDK Description | Changes |
| Account and User | Provides a standard account service with a basic, customizable UI. | Initial release. |
| API Channel SDK | Provides an API channel for official IoT services based on the HTTP protocol. | Initial release. |
| Persistent Connection Channel | Provides a persistent connection channel for IoT scenarios within the application lifecycle. By default, it subscribes to application-level downstream push notifications. It supports both request-response and publish-subscribe models. | Initial release. |
| Bone Mobile Container | Provides the runtime environment for BoneMobile plug-ins. Integration is required to develop and run BoneMobile plug-ins. | Initial release. |
| Mobile Application Push | Provides a push service for use outside the application lifecycle. This meets requirements for application operations and message alerting. | Initial release. |
| Mobile Device Gateway | Provides sub-device management features, such as adding and deleting topology, bringing sub-devices online or offline, and managing data transmission. | None |