Sunmi Developer Docs

1. createApp（Create an App）

Basic Information

Path： /v2/appstore/appstore/createApp

Method： POST

Interface Description:

Create an App.

Request Parameter

Headers

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes

Body

Name	Type	Required	Default Value	Notes	Other Information
app_name	string	Required		app name
icon_url_uuid	string	Required		The UUID of the icon (by default, the icon extracted from APK). Get it from the interface for pic uploading.
pic_vertical_screen_uuid	string []	Required		The UUID of the portrait App screenshot. Example: [“uuid1″,”uuid2”]. Get it from the interface for pic uploading.	item type: string
├─		Optional
pic_horizontal_screen_uuid	string []	Required		The UUID of the landscape App screenshot. Example: [“uuid1″,”uuid2”]. Get it from the interface for pic uploading.	item type: string
├─		Optional
apk_uuid	string	Required		The unique identifier obtained after uploading the apk.
app_introduction	string	Required		Brief introduction to the App (at least 10 characters).
cf_id	string	Required		App Category ID
terminals	string []	Required		Compatible terminal model, like [“T1″,”V2”]	item type: string
├─		Optional
area	string []	Required		The 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
range	number	Required		Visible to: 0- all, 1- this channel
deployment_type	string	Required		Deployment type: 1- Currently only “deploy to all” is available.
language	object []	Required		The App name in multiple languages	item type: object
├─ lan_id	string	Required		Language ID
├─ name	string	Required		Name
language_introduction	object []	Required		The App introduction in multiple languages	item type: object
├─ lan_id	string	Required		language ID
├─ introduction	string	Required		Brief introduction
remarks	string	Required		Notes

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		1 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.
msg	string	Required
data	string	Required

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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes

Body

Name	Type	Required	Default Value	Notes	Other Information
lan_type	number	Required		Language: 1- Chinese, 2- English

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		code	mock: 1
data	object []	Required		Array of categories.	item type: object
├─ cf_id	string	Required		Category ID.
├─ cf_name	string	Required		Category name.
msg	string	Required		The 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		code.	mock: 1
data	object []	Required			item type: object
├─ lan_id	string	Required		Language code ID.
├─ code	string	Required		Language code.
├─ zn	string	Required		Description in Chinese.
├─ en	string	Required		Description in English.
msg	string	Required		The 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		code.	mock: 1
data	object []	Required			item type: object
├─ mm_id	string	Required		Terminal model ID.
├─ name	string	Required		Model
├─ screen_type	number	Required		Screen orientation: 0- Portrait, 1-Landscape.	mock: 1
msg	string	Required		The 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes
x-timestamp		Yes		x-timestamp (Only:undefined)
x-sign		Yes		x-sign (Only:undefined)
x-nonce		Yes		x-nonce (Only:undefined)
x-appid		Yes		x-appid (Only:undefined)

Body

Name	Type	Required	Default Value	Notes	Other Information
package_name	string	Required		Package name.

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		Return code.
data	string	Required		Empty by default.
msg	string	Required		The 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	application/json	Yes
x-timestamp		Yes		x-timestamp (Only:undefined)
x-sign		Yes		x-sign (Only:undefined)
x-nonce		Yes		x-nonce (Only:undefined)
x-appid		Yes		x-appid (Only:undefined)

Body

Name	Type	Required	Default Value	Notes	Other Information
package_name	string	Required		Package name.
remarks	string	Optional		Notes.
update_content	string	Required		Items of the upgrade.
update_flag	number	Required		Upgrade type: 1- official upgrade (default)
apk_uuid	string	Required		apk uuid

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	number	Required		code.
data	string	Required
msg	string	Required		The 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	multipart/form-data	Yes

Body

Parameter	Parameter Value	Required	Example	Notes
file	file	Yes
json	text	Yes		json format data contains the following parameters
json.md5	text	Yes		APK’s md5 verifies the integrity of the APK file
json.file_type_key	text	Yes		Default ：appstore_apk

Returned Data

Name	Type	Required	Default Value	Notes	Other Information
code	string	No
msg	string	No
data	object	No
├─ uuid	string	No		Resource ID of the file
├─ package_name	string	No		Apk package name
├─ signature	string	No		sign
├─ apk_size_origin	number	No		File size of the package
├─ version_code	number	No		version code
├─ version_name	string	No		version name
├─ down_temp_url	string	No		download 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

Parameter	Parameter Value	Required	Example	Notes
Content-Type	multipart/form-data	Yes
sign		Yes		Encrypted signature： sha.hmac(appkey,body)

Body

Parameter	Parameter Value	Required	Example	Notes
file	file	Yes
json	text	Yes		All 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

Name	Type	Required	Default Value	Notes	Other Information
code	string	Yes
msg	string	Yes
data	object	Yes
├─ uuid	string	Yes		UUID of the file
├─ temp_url	string	Yes		Private file returns temporary URL
├─ result	string	Yes		json