DocsICP FilingConsole
官方文档
首页

SDK license authorization and management

更新时间：
复制 MD 格式
产品详情
我的收藏

ApsaraVideo MediaBox SDK integrates Push SDK, Short Video SDK, ApsaraVideo Player SDK, and Queen SDK with unified license authorization and management across all platforms. This page explains how to purchase, associate, and renew a license, apply for a trial, and update application information.

Important

  1. Starting February 14, 2025 (V7.0.0 and later), the mobile ApsaraVideo Player SDK offers a Professional Edition in addition to the Standard Edition. To obtain the Professional Edition, contact our sales team. For authorization instructions, see Integrate a license.

  2. When your spending on ApsaraVideo VOD, ApsaraVideo Live, and Intelligent Media Services (IMS) reaches a certain amount, you are eligible for a free one-year license for the Professional Edition of the ApsaraVideo Player SDK. For more information, see Player SDK pricing.

  3. 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

Complete the following four steps to authorize a license for your application.

Step 1: Create an application

  1. Log on to the ApsaraVideo VOD console, go to My Licenses, select the Application Management tab, and click Create Application.

    Create Application

  2. Enter the application details based on the selected platform.

    Web platform

    Enter the Application Name and the Web Domain Name.

    Web application creation

    Web domain name format requirements:

    FormatExampleValid
    Root domain onlyaliyun.comYes
    With protocolhttp://aliyun.com or https://aliyun.comNo
    With path or subpagealiyun.com/index or aliyun.com/loginNo
    Wildcard domain*.aliyun.com or .aliyun.comNo
    Important

    To authorize multiple subdomains such as pc.aliyun.com and mobile.aliyun.com, enter only the root domain: aliyun.com.

    Mobile platform

    Select the platform, enter the Application Name, and provide the Android Package Name, iOS Bundle ID, and HarmonyOS Bundle ID.

    Mobile application creation

    Android application signature (optional)

    Note

    • This field is required if you select Android for Platform Type and check Associate Signature.

    • Binding the signature improves security and prevents other applications with the same package name from using your license.

    • The following SDK versions do not require a bound signature: ApsaraVideo MediaBox SDK V1.7.0 and later, ApsaraVideo Player SDK V5.5.2 and later, Push SDK V4.4.9 and later, and Short Video SDK V3.36.0 and later.

    Obtain the MD5 value of your Android application signature by using one of the following methods:

    • Command line: Run the following command to view the MD5 value of the signature.

      keytool -v -list -keystore your.keystore

    • Android Studio: In the right-hand sidebar, click the Gradle tab and navigate to Tasks > android > signingReport. Convert the MD5 value to lowercase and remove the colons.

      Android Studio signature

Step 2: Purchase a license

Note

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

  1. Return to the My Licenses page, select the Instance tab, and click License Purchase.

    License Purchase

  2. On the ApsaraVideo MediaBox SDK purchase page, select the SDK and feature modules. Confirm your selections and complete the purchase.

    Important

    Purchase each SDK in a separate order. SDKs must be purchased separately to ensure correct license activation.

    Purchase page

  3. After payment, return to the Instance tab. The purchased license appears in the list.

Step 3: Associate a license

  1. Return to the My Licenses page, select the License Management tab, and click Associate License.

    Associate License

  2. On the Associate License page, select the application and the corresponding SDK license order. Confirm the information and click Associate.

    Note

    Each license order can be associated with only one application.

    Associate License page

  3. After the association succeeds, return to the License Management tab. The associated application name and its authorization information are displayed.

Step 4: Obtain authorization information

  1. On the License Management tab, locate the target application.

    License Management

  2. Confirm that the authorization information is correct. Click Download Certificate to download the license certificate file. Save the License Key to integrate into your application. For license configuration instructions, see Configure a License.

Renew a license

Renew a license before it expires by using one of the following methods.

Method 1: Renew from the License Management page

  1. Go to My Licenses in the ApsaraVideo VOD console.

  2. Select the License Management tab. Find and save the Instance ID associated with the target application.

    Important

    • If the Instance ID is empty or an error occurs during renewal, use Method 2 or submit a ticket.

    • Renewal applies to the entire license order. If your order includes multiple SDKs, the renewal covers all of them at once. You cannot modify the configuration during renewal. For questions, submit a ticket.

    Instance ID

  3. Go to the Resource Renewal page in the Expenses and Costs console. Search by the saved Instance ID, then click Renew in the Actions column.

  4. Confirm your current configuration and the purchase duration. Click Buy Now to complete the renewal. We recommend that you select Auto-renewal to prevent service interruptions due to expiration.

    Renewal page

Method 2: Purchase a new license and associate it

If the Instance ID is empty or an error occurs during renewal, purchase a new license from the buy page before your current license expires. Then follow the instructions in Step 3: Associate a license to associate the new license with your application. This prevents service interruptions caused by SDK call failures.

Apply for a trial license

Submit an application for a trial license. Applications are typically processed within one to two business days.

After the trial license is approved, follow Step 3: Associate a license and Step 4: Obtain authorization information to associate the trial license and download the certificate. When you are ready for production, purchase an official license and associate it with your application.

Modify application information

If your application information changes, update it in the console.

Important

Modifying an application identifier such as a package name causes authentication to fail for applications using the original identifier. You must download and replace the license certificate file. Proceed with caution.

  1. Log on to the ApsaraVideo VOD console.

  2. In the left navigation pane, choose SDK Management > My Licenses.

  3. Click the Application Management tab, find the target application, and click Edit.

  4. Modify the application name, platform, Android application signature MD5 hash, and application identifiers such as the package name.

  5. Click Modify to save the changes.

FAQ

Does the License Key change after renewal?

If you use Method 2 to renew by purchasing a new license, download the updated license certificate file and integrate it into your application. For configuration instructions, see Configure a License.

What happens if a license expires?

An expired license causes SDK call failures, which results in service interruptions. Renew your license before it expires to avoid disruption.

Can one license be associated with multiple applications?

No. Each license order can be associated with only one application. Purchase a separate license for each application.

What is the difference between the two renewal methods?

Method 1 extends your existing license order through the Resource Renewal page. Method 2 is a fallback: purchase a new license and associate it with your application. Use Method 2 when the Instance ID is empty or renewal errors occur.

Previous：Manage a licenseNext：Integrate a license