FAQ about the licenses for Push SDK, Short Video SDK, Player SDK, and Queen SDK - Apsara Video SDK

This topic provides answers to some commonly asked questions about SDK licenses.

What should I do if a license error is reported when I am using Player SDK for Web?

Problem description: A license error is reported when I am using Player SDK for Web.

Solution: Purchase a license if you're using Player SDK V2.28.0 or later. This license cannot be used for Player SDK of a version earlier than 2.28.0. We recommend that you use Player SDK V2.29.1 or later. If you have not purchased a license, purchase one on the ApsaraVideo MediaBox SDK buy page and then bind it to your application.

What should I do if a license error is reported when I am using Player SDK for mobile clients?

Problem description: An error similar to "License verify premium func:abr" appears when I am using Player SDK for mobile clients V7.0.0 or later.

Solution: Player SDK V7.0.0 or later has different editions that offer varying features. If you want to use features of Professional Edition, such as advanced ABR policies, purchase a Professional Edition license. For more information, see Obtain the license of ApsaraVideo VOD Player SDK.

How do I view the expiration time of a license and renew it?

View the expiration time of a license

Log on to the ApsaraVideo VOD console.
In the left-side navigation pane, choose SDK Management > My Licenses.
Click the License Management tab, find the license order bound to the application, and then view the expiration time in the Expiration Date column.

Renew a license

See Renew a license.

Important

If the expiration time of the license that you received in a text message does not match the validity date of the license in the console, the system has extended the validity period due to historical reasons. The expiration date in the console prevails. Ignore the expiration prompt on the Resource Renewal page. We recommend that you disable the auto-renewal feature.
If your license order covers a combination of multiple SDKs, you must renew the entire license order and cannot renew it separately. To renew a license:
1. Click Renew in the Actions column if your license order has the corresponding instance ID.
2. Purchase a license on the ApsaraVideo MediaBox SDK buy page and then bind it to your application if your license order has no instance ID.

How do I troubleshoot the error reported when I bind a license to an application?

Perform the following steps:

Check whether the license authorization configurations created in the ApsaraVideo VOD or Live console are correct.
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 of the My Licenses page, find the desired application and click Details in the Actions column. The application details page appears and displays basic information about the application and the bound license.
4. Check whether the following information is correct:
  - Basic information, such as the package name and signature. We recommend that you do not bind a signature to a license.
  - License information, such as SDK version, authorization type, expiration date, license status, and purchased value-added services.
Check whether the license configurations in the project are correct and consistent with the license information created in the console.
- Web: Check the configurations for player initialization such as the license configuration.
  - Domain: Check whether the domain of the page where the player is embedded is a subdomain of or have the same name as the domain you specified when applying for the license.
  - License key: Check whether the license key configured in the project is the same as the one displayed in the console.
- Android: Check the configurations such as the AndroidManifest.xml configuration file.
  - License key: Check whether the value of com.aliyun.alivc_license.licensekey is the same as the license key displayed in the console.
  - License file: Check whether the value of com.aliyun.alivc_license.licensefile is the same as the path in which your license file is stored.
  - Package name: Check whether the value of applicationId in the build.gradle file is the same as the package name displayed in the console.
  - Package signature: If you choose to bind a signature when creating the license in the console, check whether the signature configured in the project is the same as that displayed in the console. You can run the following command to query your package signature: keytool -v -list -keystore your.keystore.
- iOS: Check the configurations such as the Info.plist configuration file.
  - Bundle ID: Check whether the value of CFBundleIdentifier is the same as the bundle ID configured in the console.
  - License key: Check whether the value of AlivcLicenseKey is the same as the license key displayed in the console.
  - License file: Check whether the value of AlivcLicenseFile is the same as the path of the license file in your IPA package.
- HarmonyOS: Check the configurations such as the module.json5 configuration file.
  - Bundle ID: Check whether the value of bundleName in the application.json5 file is the same as the bundle ID configured in the console.
  - License key: Check whether the value of com.aliyun.alivc_license.licensekey is the same as the license key displayed in the console.
  - License file: Check whether the value of com.aliyun.alivc_license.licensefile is the same as the path of the license file in your HAP package.

Do I need to update the license file and license key of an application after I purchase a license and bind it to the application?

We recommend that you update the license file. After you bind a new license to an application, its expiration date in the license file is also updated. Integrating the updated license file helps improve the success rate of request authentication. In most cases, license updates do not affect the operation of your online application.
We recommend that you do not change the license key, because it's bound to the UID.

How do I modify the application ID?

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.

Log on to the ApsaraVideo VOD console.
In the left-side navigation pane, choose SDK Management > My Licenses.
On the Application Management tab, find the desired application and click Edit in the Actions column.
Modify the application name, platform, MD5 hash, and application identifiers such as package name.
Confirm the settings and click Modify.

Can I modify the MD5 signature of my Android application?

Modifying verification configurations, such as MD5 signature, may lead to verification failures of SDKs in published versions of the application. As a result, the application cannot work as expected. Proceed with caution.

If you modify the MD5 signature from A to B, the application originally configured with MD5 signature A will not work as expected. In this case, we recommend that you create another application with the same package name as the existing application and specify B as the MD5 signature for the new application.
If you unbind the signature, the SDKs of the following versions will fail the verification.
- ApsaraVideo MediaBox SDK V1.6.0 and earlier
- Player SDK V5.5.1.0 and earlier
- Push SDK V4.4.8 and earlier
- Short Video SDK V3.35.0 and earlier

How do I modify the SDK versions, modules, or features?

Changing the configurations is not supported by using the ApsaraVideo VOD console. To add SDK modules, modify SDK versions, or modify SDK features, submit a ticket.

What should I do if I am prompted that I do not have the required permissions?

Before you log on to the ApsaraVideo VOD console as a RAM user, you must authorize the RAM user to use the console. Otherwise, one of the following errors may appear:

The following error is reported if the RAM user is not authorized to access the ApsaraVideo VOD console:
The following error is reported if the RAM user is not granted the permissions to view, pay for, or cancel orders in the Expenses and Costs console: