Publish and manage Apps API

1. createApp(Create an App)

Basic Information

Path: /v2/appstore/appstore/createApp

Method: POST

Interface Description:

Create an App.

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes

Body

NameTypeRequiredDefault ValueNotesOther Information
app_namestringRequiredapp name
icon_url_uuidstringRequiredThe UUID of the icon (by default, the icon extracted from APK). Get it from the interface for pic uploading.
pic_vertical_screen_uuidstring []RequiredThe UUID of the portrait App screenshot. Example: [“uuid1″,”uuid2”]. Get it from the interface for pic uploading.item type: string
├─ Optional
pic_horizontal_screen_uuidstring []RequiredThe UUID of the landscape App screenshot. Example: [“uuid1″,”uuid2”]. Get it from the interface for pic uploading.item type: string
├─ Optional
apk_uuidstringRequiredThe unique identifier obtained after uploading the apk.
app_introductionstringRequiredBrief introduction to the App (at least 10 characters).
cf_idstringRequiredApp Category ID
terminalsstring []RequiredCompatible terminal model, like [“T1″,”V2”]item type: string
├─ Optional
areastring []RequiredThe countries and regions the App released to: 1- China Mainland, 2- Hong Kong, Macau, Taiwan, 3- Other countries and regions. Example:[1,2,3]item type: string
├─ Optional
rangenumberRequiredVisible to: 0- all, 1- this channel
deployment_typestringRequiredDeployment type: 1- Currently only “deploy to all” is available.
languageobject []RequiredThe App name in multiple languagesitem type: object
├─ lan_idstringRequiredLanguage ID
├─ namestringRequiredName
language_introductionobject []RequiredThe App introduction in multiple languagesitem type: object
├─ lan_idstringRequiredlanguage ID
├─ introductionstringRequiredBrief introduction
remarksstringRequiredNotes

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequired1 success,
15000 system error,
13011 failed to pass iconUrl detection, 
13010 failed to pass portrait pic detection,  
13009 failed to pass landscape pic detection, 
13002 App package already exists, 
13012 illegal App category, 
13013 compatible terminal model contains illegal content.
msgstringRequired
datastringRequired

1.1 getClassifyList(Get the List of App Categories)

Basic Information

Path: /v2/appstore/appstore/app/getClassifyList

Method: POST

Interface Description:

Get the list of App categories.

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes

Body

NameTypeRequiredDefault ValueNotesOther Information
lan_typenumberRequiredLanguage: 1- Chinese, 2- English

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequiredcodemock: 1
dataobject []RequiredArray of categories.item type: object
├─ cf_idstringRequiredCategory ID.
├─ cf_namestringRequiredCategory name.
msgstringRequiredThe information returned.mock: “”

1.2 getLanguageList(Get the list of Language Codes)

Basic Information

Path: /v2/appstore/appstore/app/getLanguageList

Method: POST

Interface Description:

Get the list of Language Codes

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequiredcode.mock: 1
dataobject []Requireditem type: object
├─ lan_idstringRequiredLanguage code ID.
├─ codestringRequiredLanguage code.
├─ znstringRequiredDescription in Chinese.
├─ enstringRequiredDescription in English.
msgstringRequiredThe information returned.

1.3 getTerminalList(Get the List of Terminal Models)

Basic Information

Path: /v2/appstore/appstore/app/getTerminalList

Method: POST

Interface Description:

Get the List of Terminal Models

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequiredcode.mock: 1
dataobject []Requireditem type: object
├─ mm_idstringRequiredTerminal model ID.
├─ namestringRequiredModel
├─ screen_typenumberRequiredScreen orientation: 0- Portrait, 1-Landscape.mock: 1
msgstringRequiredThe information returned.

2. removeApp(Delete an App)

Basic Information

Path: /v2/appstore/appstore/app/removeApp

Method: POST

Interface Description:

Delete an App.

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes
x-timestampYesx-timestamp (Only:undefined)
x-signYesx-sign (Only:undefined)
x-nonceYesx-nonce (Only:undefined)
x-appidYesx-appid (Only:undefined)

Body

NameTypeRequiredDefault ValueNotesOther Information
package_namestringRequiredPackage name.

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequiredReturn code.
datastringRequiredEmpty by default.
msgstringRequiredThe information returned.

3.upgradeAppVersion(Upgrade App Version)

Basic Information

Path: /v2/appstore/appstore/app/upgradeAppVersion

Method: POST

Interface Description:

Upgrade App Version.

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typeapplication/jsonYes
x-timestampYesx-timestamp (Only:undefined)
x-signYesx-sign (Only:undefined)
x-nonceYesx-nonce (Only:undefined)
x-appidYesx-appid (Only:undefined)

Body

NameTypeRequiredDefault ValueNotesOther Information
package_namestringRequiredPackage name.
remarksstringOptionalNotes.
update_contentstringRequiredItems of the upgrade.
update_flagnumberRequiredUpgrade type: 1- official upgrade (default)
apk_uuidstringRequiredapk uuid

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codenumberRequiredcode.
datastringRequired
msgstringRequiredThe information returned.

4.uploadApk(Upload APK)

Basic Information

Path: /v2/midplat/filecore/file/uploadApk

Method: POST

Interface Description:

Used to upload apk. Field value: file_type_key defaults to appstore_apk

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typemultipart/form-dataYes

Body

ParameterParameter ValueRequiredExampleNotes
filefileYes
jsontextYesjson format data contains the following parameters
json.md5textYesAPK’s md5 verifies the integrity of the APK file
json.file_type_keytextYesDefault :appstore_apk

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codestringNo
msgstringNo
dataobjectNo
├─ uuidstringNoResource ID of the file
├─ package_namestringNoApk package name
├─ signaturestringNosign
├─ apk_size_originnumberNoFile size of the package
├─ version_codenumberNoversion code
├─ version_namestringNoversion name
├─ down_temp_urlstringNodownload url

5.uploadImage(Upload Image)

Basic Information

Path: /v2/midplat/filecore/file/uploadImage

Method: POST

Interface Description:

Used to upload App screenshots.

file_type_key :

icon:appstore_icon;landscape screenshots:appstore_hscreenshot;portrait screenshots:appstore_vscreenshot

Request Parameter

Headers

ParameterParameter ValueRequiredExampleNotes
Content-Typemultipart/form-dataYes
signYesEncrypted signature: sha.hmac(appkey,body)

Body

ParameterParameter ValueRequiredExampleNotes
filefileYes
jsontextYesAll parameters except file are put here, such as:{“file_type_key”:””,”md5″:””}
file_type: the type of business
md5: MD5 verification integrity of the file

Returned Data

NameTypeRequiredDefault ValueNotesOther Information
codestringYes
msgstringYes
dataobjectYes
├─ uuidstringYesUUID of the file
├─ temp_urlstringYesPrivate file returns temporary URL
├─ resultstringYesjson