All Products
Search
Document Center

Apsara Video SDK:Manage licenses

Last Updated:Mar 25, 2024

ApsaraVideo MediaBox SDK integrates ApsaraVideo Push SDK, ApsaraVideo Short Video SDK, ApsaraVideo Player SDK, and ApsaraVideo Queen SDK and allows you to manage licenses for Android and iOS applications in a centralized manner. This effectively simplifies SDK integration. This topic describes how to apply for a license, renew a license, and modify the authorization information of an application that is bound to a license.

Apply for a license

  1. Log on to the ApsaraVideo Live or ApsaraVideo VOD console.

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

  3. Click Create Application and Bind License.

  4. Configure the application information.

    Note

    Each license can be bound to only one Android application and one iOS application.

    Parameter

    Description

    Application Title

    The application name. The name can be up to 128 characters in length and can contain letters, digits, and underscores (_). Special characters such as spaces are not supported.

    Platform

    The operating system on which the application runs. Valid values: Android and iOS.

    Package Name

    The name of the Android application package. The name can be up to 128 characters in length and can contain letters, digits, underscores (_), and periods (.). Special characters such as spaces are not supported.

    Note

    You must configure this parameter if you set the Platform parameter to Android.

    Signature (MD5)

    The message-digest algorithm 5 (MD5) value of the signature for the Android application. The value must be 32 characters in length and can contain lowercase letters and digits. Special characters such as spaces are not supported. You can use one of the following methods to obtain the MD5 value:

    • Run the keytool -v -list -keystore your.keystore command to query the MD5 value.

    • Obtain the MD5 value in Android Studio. To do so, click Gradle in the right-side navigation pane and choose Tasks > android > signingReport for the application. In this case, you must convert the letters in the obtained MD5 value to lowercase letters and remove semicolons (;) from the value.image.png

    Note
    • You must configure this parameter if you set the Platform parameter to Android and select Add Signature.

    • After you add a signature to a license, the signature security is improved. In addition, this prevents the license from being used by another application with the same package name.

    • You do not need to add a signature to a license for the following versions of SDKs: ApsaraVideo MediaBox SDK V1.7.0 and later, ApsaraVideo Player SDK V5.5.2 and later, ApsaraVideo Push SDK V4.4.9 and later, and ApsaraVideo Short Video SDK V3.36.0 and later.

    Bundle ID

    The bundle ID of the iOS application. The ID can be up to 128 characters in length and can contain letters, digits, periods (.), and underscores (_). Special characters such as spaces are not supported.

    Note

    You must configure this parameter if you set the Platform parameter to iOS.

  5. Click Next to go to the Select Functional Module step. In this step, you can specify whether to bind the application to a previously purchased license.

    Perform operations based on whether you have purchased licenses.

    • If you have purchased licenses, select a license that is not bound to an application from the drop-down list. If no purchased license is available, you can visit the ApsaraVideo MediaBox SDK buy page to purchase a license. Then, select the license from the drop-down list.

    • If you have not purchased licenses, select Create SDK License Order without Writing off Previous Order from the drop-down list. Then, select an SDK combination and functional modules based on your business requirements.

  6. Confirm your configurations and click Create.

    A message appears to indicate that you need to pay for the order. Click Pay Now and complete the payment.

  7. Download the license file.

    After a license is created, you can download the license file to your on-premises machine for your application to subsequently access the required SDK. For more information about how to bind the license file to an application, see Bind a license.

    On the My Licenses page, find the application whose license file you want to download and click Show to display the application license information. Click Download License File in the upper-right corner and obtain the license key.

    image.png

Renew a license

If you have purchased a service such as ApsaraVideo Short Video SDK or ApsaraVideo Queen SDK, you must renew your license in the ApsaraVideo VOD console before the license expires. This prevents service exceptions that occur because your application cannot use the SDK.

  1. Log on to the ApsaraVideo Live or ApsaraVideo VOD console.

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

  3. Find the application for which you want to renew the license and click Show to display the application license information. Then, click Renew in the upper-right corner.

  4. Confirm the authorization information, validity period, and price of the license to be renewed, and click Renew. A renewal order is generated. Pay for the order as prompted.

    After the payment is complete, you can view the validity period of the renewed license.

Modify the authorization information of an application bound to a license

If the information about an application changes, you can modify the authorization information of the application in the ApsaraVideo VOD console.

Important
  • If you modify the package name or bundle ID of an application in the authorization information of the application, the application may fail to be authorized. As a result, the application cannot use the required SDK. Proceed with caution.

  • You cannot change the MD5 value of the signature for an Android application or change the authorized functional module in the ApsaraVideo VOD console. To make such changes, submit a ticket.

  1. Log on to the ApsaraVideo Live or ApsaraVideo VOD console.

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

  3. Find the application whose authorization information you want to modify and click Show to display the information. Then, click Edit in the upper-right corner.

  4. Modify the application name, operating system, or package name or bundle ID of the application.

  5. After you confirm the modification, click Modify.

FAQ

FAQ about licenses