Apsara Video SDK:Manage licenses

Step 1: Create an application

1. Go to the My Authorizations page in the ApsaraVideo VOD console. On the Application Management tab, click Create Application.

2. Enter the application information. Applications are categorized by platform: Web or Mobile.

   • Web: Enter an Application Name and the corresponding Web Domain. Select I understand and agree to the compliance commitments (click View Statement for details), and then click Create.

     

     Web domain guidelines

     • Example of a valid domain: aliyun.com. To cover multiple subdomains, such as pc.aliyun.com and mobile.aliyun.com, enter only the primary domain name aliyun.com.

     • Avoid the following formats:

       • Including a protocol prefix: http://aliyun.com or https://aliyun.com.

       • Including a path or subpage: aliyun.com/index or aliyun.com/login.

       • Using a wildcard domain: *.aliyun.com or .aliyun.com.

   • Mobile: Select a platform, enter an Application Name, and provide the corresponding Android package name, iOS Bundle ID, and HarmonyOS Bundle ID to create the application.

     The HarmonyOS Bundle ID can be found in the bundleName field of your project's app.json5 file. After you enter the information, select the Compliance Commitment checkbox and click Create.

     

     Bind an Android application signature

     • This field is required if you select Android for the Platform Type and select Bind Signature.

     • Binding a signature enhances security by preventing other applications with the same package name from using the license.

     • Newer SDK versions do not require a bound signature, including ApsaraVideo MediaBox v1.7.0 and later, player SDK v5.5.2 and later, live streaming SDK v4.4.9 and later, and short video SDK v3.36.0 and later.

       You can obtain the MD5 value of your Android application signature in two ways:

     • Run the keytool -v -list -keystore your.keystore command to view the MD5 value of the corresponding signature.

     • From Android Studio: Click Gradle in the right-hand sidebar and navigate to Tasks > android > signingReport for the app. Convert any letters in the resulting MD5 value to lowercase and remove the colons.

Step 2: Purchase a license

1. Return to the My Authorizations page, select the Order Instances tab, and click Purchase License.

2. On the ApsaraVideo MediaBox purchase page, select the SDK and function modules based on your business needs (SDK entitlements cannot be combined in a single purchase), and complete the purchase.

   When you purchase a player SDK license, ensure that the platform you select matches your application's platform type. A mismatch causes the license binding to fail.

   Note

   SDK benefits can only be purchased separately. For example, Player SDK Standard Edition can be purchased separately.On the MediaBox Audio and Video SDK purchase page, select the version of each SDK module as needed.After the selection is completed, confirm the purchase quantity and payable expenses, and click Buy Now to complete the payment.

3. After the payment is successful, return to the Order Instances tab to view your new order instance.

Step 3: Bind a license

1. Return to the My Authorizations page, select the License Management tab, and click Bind License.

2. On the Bind License page, select the application and the SDK license order to bind. Each license order can be bound to a single application, covering either Web or Mobile platforms.

3. In the Authorized Platforms section, select the platforms that you want to authorize, such as Android. A mobile license is valid only for a mobile application.

4. After you confirm the information, click Bind.

   After a successful binding, return to the License Management tab to view the bound application name and its authorization information.

Step 4: Obtain authorization information

1. On the License Management tab, find the target application. Your License Key is displayed at the top of the page. Click the copy button to copy the key. A Download Certificate link is available under each application name in the list.

2. After you confirm the authorization details, click Download Certificate to save the license file to your local machine. Also, save the license key for use during application integration. For instructions on configuring the license file, see Integrate a license.

In most cases, renew your license directly from the License Management page (Method 1). If the instance ID of your license order is empty or a console error occurs during renewal, use Method 2 instead.

Method 1: Renew from the License Management page (recommended)

Renewal applies to the entire license order. If your license order includes multiple SDK entitlements, all of them are renewed together. You cannot change the configuration during renewal. If you have questions, submit an Alibaba Cloud ticket.

1. Go to the My Authorizations page in the ApsaraVideo VOD console.

2. Select the License Management tab, then find and save the instance ID that is bound to the target application.

   

   If the instance ID is empty or an error occurs in the console during renewal, use Method 2: Purchase a new license and bind the application or submit an Alibaba Cloud ticket for renewal.

3. Go to the Renewals page in the Expenses and Costs console. Search for the saved instance ID, find the order, and then click Renew in the Actions column.

4. On the ApsaraVideo MediaBox renewal page, confirm your current configuration and the renewal duration, and then click Buy Now to complete the renewal.

   

   (Recommended) Enable auto-renewal to prevent expiration.

Method 2: Purchase a new license and bind the application

If the instance ID is empty for your purchased SDK license or if an error occurs during renewal, you must purchase a new license from the ApsaraVideo MediaBox purchase page before your current license expires. After the purchase, follow the instructions in Step 3: Bind a license to prevent service interruptions.

For more frequently asked questions, see License-related FAQ.