# The QIYU Developer Platform Tool (DPT)

# Catalog

# Important: Read Before Upload!!!

Please note before reading the instructions: if you use the QIYU Developer Platform tool to upload your APK, please back to the QIYU Developer Platform website to submit after uploading the APK successfully. If you only upload the APK on the platform tool but do not submit on the QIYU developer platform website, QIYU will not review and publish the APK you uploaded

# The Introduction of QIYU Developer Platform Tool (DPT)

The QIYU Developer Platform Tool is a command-line tool. You can upload an APK and OBB package by using it. Compared to uploading an APK from a web page, this command-line tool offers more stable connection and it also supports bigger size pacakges.

Please find below the size limit for uploading one APK or OBB file:

  • APK:Size not larger than 3.5G
  • OBB:Size not larger than 3.5G

# The way to use the DPT

1、Please make sure that you have already downloaded and installed the DPT, See the Download installation instructions for the DPT for details

2、Mac users need to click system preferences when using it for the first time. In security and privacy, clicking "is still allowed“

3、If you want to user the DPT, you need to drag and drop the DPT to the terminal The following picture shows the effect after dragging without entering any command lines

screenshot of Mac

screenshot of Windows

# Check DPT Version

After draging and droping the DPT to the terminal, enter the space and type "version", you can check the DPT Version

You can check the version number of DPT.

screenshot of Mac

screenshot of Windows

# Get Help with the DPT

  • Menu Command After draging and droping the DPT to the terminal, enter the space and type "--help", you can view the menu in DPT

screenshot of Mac

screenshot of Windows

  • Help Command If you want to get the additonal help of the specific function, for instance:"upload-qiyu-build". you can drag and drop the DPT to the terminal, enter the space and type "upload-qiyu-build", and then enter the sapce again and type"--help"

You can see the Parameters and their descriptions of this command

# Update DPT

$ qyvr-platform-util self-update You can use this command to update your DPT.

If you already have the latest version, then

# Obtain DPT's Credentials

  • Obtain Credentials to use the DPT You can access the User Token on the DPT with the get-access-token command.

After fill in the email、APPID、APP Secret,you can get theUser Token

  • Check the APPID/APP Secret/ USer Token on website

    1. Find your app in the app list, then click the API button to go to the API page, where you can find the APP ID and the APP Secret.

    2. You can also click the 'Generate Token' button to get the User Token.

Please find the below screenshot for your reference:

# Upload an APK

After draging the DPT to the terminal, enter the space and type "upload-qiyu-build"

# Parameters

Syntax Description
APP ID -a This is required to upload an APK. Obtainable from the API page.
APP Secret -s Either the app secret or the user token required. Obtainable from the API page
User Token -t Either the app secret or the user token required. Obtainable from using the get-access-token command.
apk filePath --apk TEXT Required. Please specify the APK file's location.
obb filePath --obb TEXT Optional. Please specify the OBB file's location.
release note -n Optional. Please specify the release notes shown to the users.

Please note that:You need to type in a space for each command(example:-a 11111)

# Example

The following example shows how to upload an APK file. Note that this instance is done on Mac.

APP ID:123

APP Secret:123abc

APK filePath:/Users/Shared/test123.apk

Type in this command:$ /Users/Shared/qyvr-platform-util upload-qiyu-build -a 123 -s

The upload progress and waiting time will be displayed in the form of progress bar

After upload the apk successfully, please go to the website and choose the latest version that you have already uploaded, and then submit for review

# Error prompt and reason

serial-number Name reason remarks
1 Unknown erro Other exception
2 Fail to read file Failed to read or parse the currently uploaded APK file The file may not be readable or parsed according to the APK file
3 Non-VR APP Currently, no Qualcomm XR interface file is detected when uploading APK fil check in lib/arm64-v8a/libsxrapi.so
4 Package names didn't match The package name of the currently uploaded APK file is inconsistent with the package name of the version uploaded and approved in history
5 No version number detected The version number of the currently uploaded APK file is not obtained check in the value of versionCode in AndroidManifest.xml
6 The version number is too low The currently uploaded APK version number is less than or equal to the version uploaded nearby in history check in the value of versionCode in AndroidManifest.xml
7 Informal version The currently uploaded APK file is a debug version check in the value of debugable in AndroidManifest.xml, if it is true,then it is a debug version
8 APK not signed The current uploaded APK file signature is inconsistent with the APK signature uploaded and approved in history
9 Signatures didn't match The currently uploaded APK file signature certificate is inconsistent with the APK signature certificate uploaded and approved in history
10 Certificates didn't match The APK file signature certificate currently uploaded is inconsistent with the APK signature certificate uploaded and approved for the first time
11 Certificate parsing failed Apk file signature certificate parsing exception
12 QIYU SDK not integrated The game APK file does not detect the relevant so file of adventure SDK
13 The SDK version too low, please upgrade to X+ The version of adventure SDK is lower than the minimum version requirement of background configuration X is the minimum version of the current background configuration, and the value is 1.0.0
14 Android SDK version too low, please upgrade to X+ The Android SDK version is lower than the minimum version required for background configuration X is the minimum version of the current background configuration, and the value is 26. For details and other historical versions, please refer to:https://en.wikipedia.org/wiki/Android_version_history
15 The signing certificate is invalid Signed APK with Android debug certificate Resign APK with own certificate
16 The QIYU Platform SDK is not integrated The application did not intergrate the QIYU platform SDK To protect the asserts of application, the platform SDK must be integrated if the application will be lived on QIYU store.
Unity: https://dev-qiyu.iqiyi.com/doc/zh/develop/unity/platform/platformsdk.html (opens new window)
Unreal: https://dev-qiyu.iqiyi.com/doc/zh/develop/unreal/platformsolution.html (opens new window)

# Download an APK

The command for downloading an APK is as below: $ qyvr-platform-util download-qiyu-build

# Parameters

Syntax Description
Build ID -b Required. Please specify a build ID, obtainable from the developer dashboard.
directory -d Optional. Please specify a location to download the file to.

# Example

The following example shows how to download an APK file. Note that this instance is done on Mac.

Build ID:1020

directory:/Users/Shared

Type in this command: $ qyvr-platform-util download-qiyu-build -b 1020 -d /Users/Shared

The download progress and waiting time will be displayed in the form of progress bar

# Log storage

$ qyvr-platform-util logdir

After dragging the DPT to the terminal, enter the space and type "logdir". You can view the directory where the log is stored. If you have problems about uploading, you can send the log to our staff to view the problems for you.