All Products
Search

This Product

    Apsara Video SDK:Manage licenses

    Document Center

    Apsara Video SDK:Manage licenses

    Last Updated:Apr 17, 2025

    ApsaraVideo MediaBox SDK integrates audio and video functionalities including stream ingest, playback, short video production, and retouching. It also offers a unified license authorization system to grant access to these modules. This topic describes how to purchase, bind, and renew a license, as well as how to apply for a trial license and modify the information about the bound application.

    Important

    Starting December 1, 2024, using Player SDK for Web V2.28.0 or later requires a license. Versions prior to 2.28.0 are not affected by this change. However, we recommend that you update Player SDK to the latest version for more comprehensive services and support.

    Request a license for authorization

    Step 1: Create an application

    1. Go to the My Licenses page in the ApsaraVideo VOD console, select the Application Management tab, and click Create Application.image

    2. Edit the application information. Applications are divided into web and mobile applications.

      1. Web: Enter the Application Name and Web Domain Name.image

        Guidelines on web domain names:

        • Correct example: aliyun.com.

          Important

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

        • Incorrect examples:

          • Including protocol headers: http://aliyun.com or https://aliyun.com.

          • Including paths or subpages: aliyun.com/index or aliyun.com/login.

          • Using wildcard domains: *.aliyun.com or .aliyun.com.

      2. Mobile: Enter the Application Name, Android Package Name, Bundle ID, and HarmonyOS BundleID.

        image

        Associate the signature of an Android application

        Note

        • If you select Android as the Platform Type and Associate Signature, the signature is required.

        • This operation improves application security and prevents the license from being used by another application with the same package name.

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

        To obtain the MD5 signature of an Android application, use one of the following methods:

        • Run the keytool -v -list -keystore your.keystore command.

        • To obtain the signature from Android Studio, click Gradle in the right-side navigation pane, find the desired application, and then choose Tasks > android > signingReport. In this case, you must convert the letters into lowercase and remove semicolons (;) from the obtained MD5 signature.image.png

    Step 2: Purchase a license

    Note

    If you have already purchased a license, directly bind the license to your application.

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

    2. Go to the ApsaraVideo MediaBox SDK buy page, select the SDK and corresponding functional modules based on your business requirements, and complete the purchase.

      Important

      As shown in the following figure, SDKs can only be purchased separately. For example, you need to purchase Standard Edition of Player SDK individually.image

    3. Pay for the order and return to the Instance tab, where you can see the newly purchased instance.

    Step 3: Bind the license

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

    2. On the Associate License page, select the application you want to bind and the corresponding SDK license order, and then click Associate.

      Note

      Each license order can be bound to only one web or mobile application.

      image

    3. Return to the License Management tab, where you can see the bound application name and corresponding license information.

    Step 4: Obtain license information

    1. On the License Management tab, find the desired application.image

    2. Click Download Certificate to download the certificate file to your local device, and save the license key for use when integrating the application. For how to configure the license file, see Bind a license.

    Renew a license

    Method 1: Renew on the License Management page

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

    2. Select the License Management tab, find the instance ID bound to the corresponding application, and click Renew in the Actions column.

      Important

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

      2. Renewal applies to the license order. If your license order includes multiple SDKs, the renewal will apply to all SDKs as a whole. Configuration changes are not supported. If you have any questions, submit a ticket.

      image

    3. Go to the renewal management page and click Renew in the Actions column.image

    4. After confirming that your current configuration and subscription duration are correct, click Buy Now to complete the renewal. Auto-renewal is recommended to avoid expiration.image

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

    If you have purchased an SDK license but the corresponding order instance ID is empty or an error occurs in the console during renewal, place an order on the ApsaraVideo MediaBox SDK buy page before the existing license expires. Then, proceed with Step 3: Bind the license to prevent business disruptions that may occur if your application fails to call the SDK.

    Apply for a trial license

    You can apply for a trial license by submitting a request on Yida. The request will be processed within 1 to 2 business days.

    Modify application information

    You can modify the information about the application that is bound to a license in the console.

    Important

    Modifying the application identifiers such as package name will cause authentication failures for applications with the original identifiers. You must download the new certificate file to replace the old one. Proceed with caution.

    1. Log on to the ApsaraVideo VOD console.

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

    3. On the Application Management tab, find the desired application and click Edit in the Actions column.

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

    5. Confirm the settings and click Modify.

    FAQ

    How do Alibaba Finance Cloud users request a license for authorization?

    Place an order on the ApsaraVideo MediaBox SDK buy page, and then submit a ticket to bind the license to your application. Alibaba Cloud does not provide notifications regarding the SDK license expiration date. You need to monitor the expiration date yourself to prevent business interruptions. When submitting a ticket, include the following information:

    • Mention that you are a Finance Cloud user and include the order number, a screenshot of the purchase, and your account ID.

    • Provide the domain name for web applications and package name for mobile applications.

    For more questions, see License FAQ.