Manage SDK licenses - Apsara Video SDK - Alibaba Cloud Documentation Center

ApsaraVideo MediaBox SDK integrates Push SDK, Short Video SDK, ApsaraVideo Player SDK, and Queen SDK with unified license management across all platforms. Purchase, bind, renew, and modify licenses for your applications.

Important

Starting February 14, 2025 (V7.0.0 and later), the mobile ApsaraVideo Player SDK offers a Professional Edition in addition to the Standard Edition. Contact our sales team to obtain it. For authorization instructions, see Integrate a license.
When your spending on ApsaraVideo VOD, ApsaraVideo Live, and Intelligent Media Services (IMS) reaches the threshold, you qualify for a free one-year Professional Edition ApsaraVideo Player SDK license. For more information, see ApsaraVideo Player SDK billing.
The Professional Edition license for the mobile ApsaraVideo Player SDK is only compatible with V7.0.0 and later. Before obtaining a license, check the SDK version in your application.

Authorize a license

Step 1: Create an application

Log on to the ApsaraVideo VOD console, go to My Licenses, select the Application Management tab, and click Create Application.
Enter the application details based on the selected platform.
1. Web: Enter the Application Name and the corresponding Web Domain Name.
  Notes on web domain name:
  - Correct format example: aliyun.com.
    
    Important
    To authorize multiple subdomains, such as pc.aliyun.com and mobile.aliyun.com, enter only the root domain: aliyun.com.
  - Incorrect format examples:
    - Including a protocol: http://aliyun.com or https://aliyun.com
    - Including a path or subpage: aliyun.com/index or aliyun.com/login
    - Using a wildcard domain name: *.aliyun.com or .aliyun.com
2. Mobile: Select the platform, enter the Application Name, and provide the corresponding Android Package Name, iOS Bundle ID, and HarmonyOS Bundle ID.
  Bind an Android application signature
  Note
  
  Required only when Platform Type is Android and Associate Signature is selected.
  
  Binding the signature improves security and prevents other applications with the same package name from using your license.
  
  Signature binding is not required for ApsaraVideo MediaBox SDK V1.7.0+, ApsaraVideo Player SDK V5.5.2+, Push SDK V4.4.9+, or Short Video SDK V3.36.0+.
  Get the MD5 of your Android application signature:
  - Command line: Run the following command to get the signature MD5.
```
keytool -v -list -keystore your.keystore
```
  - Android Studio: In the right sidebar, click the Gradle tab and go to Tasks > android > signingReport. Convert the MD5 to lowercase and remove colons.

Step 2: Purchase a license

Note

If you have purchased a license, proceed to Step 3: Associate a license.

Return to the My Licenses page, select the Instance tab, and click License Purchase.
On the ApsaraVideo MediaBox SDK purchase page, select the SDK and feature modules. Place a separate order for each SDK. Confirm your selections and complete the purchase.

Important
To ensure correct license activation, purchase each SDK in a separate order.
After payment, the purchased license appears on the Instance tab.

Step 3: Associate a license

Return to the My Licenses page, select the License Management tab, and click Associate License.
On the Associate License page, select the application and SDK license order, then click Associate.

Note
Each license order can be bound to a single application.
After binding, the License Management tab displays the associated application and its authorization details.

Step 4: Obtain authorization information

On the License Management tab, locate the target application.
Verify the authorization information. Click Download Certificate to download the license file, and save the License Key for your application. To configure the license file, see Integrate a license.

Renew a license

Method 1: Renew from the License Management page

Go to My Licenses in the ApsaraVideo VOD console.
Select the License Management tab. Find and save the Instance ID bound to the target application.
Important
1. If the Instance ID is empty or an error occurs during renewal, use Method 2 or submit a ticket to renew.
2. Renewal covers the entire order, including all SDKs. Configuration changes are not supported during renewal. For questions, submit a ticket for assistance.
Go to the Resource Renewal page in the Expenses and Costs console. Search for your order by Instance ID, then click Renew in the Actions column.
Confirm your configuration and duration, then click Buy Now to complete the renewal. Select Auto-renewal to prevent service interruptions from expiration.

Method 2: Purchase a new license and bind it to your application

If your license order has an empty instance ID or renewal fails, purchase a new license from the buy page before your current license expires. After the purchase, follow the instructions in Step 3: Associate a license.

Modify license-bound application information

Modify application information in the console as needed.

Important

Changing an application identifier such as a package name breaks authentication for applications using the original identifier. You must download and replace the license certificate file afterward.

Log on to the ApsaraVideo VOD console.
In the left navigation pane, choose SDK Management > My Licenses.
Click the Application Management tab, find the target application, then click Edit.
Modify the application name, platform, Android signature MD5 hash, or application identifiers such as the package name.
Click Modify to save.