# Preface
The Developer Center OpenAPI provides interfaces for core chains exposed by the FinClip server. It allows you to interact programmatically with the FinClip server, enabling task automation, integration with other tools, and creation of custom workflows.
# Quick Start
- In the Developer Center, navigate to your personal center and select "Create Personal Access Token"
- Select the required permissions for the current Token and create it. Note: Please save the generated Access Token securely, as it cannot be retrieved later and can only be reset.
- Select any OpenAPI interface below, and include the Authorization header in the request with the value:
Bearer {PersonalAccessToken}- Note: This header is a required parameter for all OpenAPI interfaces

- Note: This header is a required parameter for all OpenAPI interfaces
# Authorization Scope
Authorization scopes are the OpenAPI permission sets.
The following table describes the specific authorization scopes:
| Authorization Group | Authorization Scope | Description |
|---|---|---|
| Member Management | Member-View | View cooperative members |
| Member-Edit | Invite cooperative members | |
| Role-View | View roles and their permissions defined in the system | |
| Role-Edit | Edit role permissions and assign roles to members | |
| Mini-Program | Mini-Program-View | View basic information of Mini-Programs |
| Mini-Program-Edit | Edit basic settings of Mini-Programs | |
| Mini-Program Version-View | View historical version information of Mini-Programs | |
| Mini-Program Version-Edit | Publish or update Mini-Program versions | |
| Mini-Program Unified Authentication | Manage unified authentication settings for Mini-Programs | |
| Mini-Program CI | Used for quick upload of Mini-Program code packages & listing | |
| Message Subscription | Used for Mini-Program template message subscription | |
| Application | Application-View | View basic information of applications |
| Application-Edit | Edit application settings | |
| Custom API-View | View definitions and permissions of custom APIs | |
| Custom API-Edit | Create, edit, or delete custom APIs | |
| Custom Menu-View | View settings and configurations of custom menus | |
| Custom Menu-Edit | Create, edit, or delete custom menus |
# API
The following OpenAPI interfaces are organized by Authorization Scope. Only Personal Access Tokens with the corresponding authorization scope can access the specific interfaces.
# 1. Common Interfaces
Common interfaces refer to OpenAPIs that do not depend on any Authorization Scope. They are primarily basic functional interfaces related to user accounts.
# 1.1 Get Menu Permission Tree
Request URL
GET /api/v1/open/dev/auth/tree
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters None
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"permissionTree": { // Current user's permission tree
"childrenIds": [
""
],
"desc": "",
"exist": true,
"hasPermission": true,
"id": "",
"itemType": 1,
"name": "",
"parentId": ""
}
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 1.2 Generate Short Link
Request URL
GET /api/v1/open/dev/short-chain/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| lUrl | string | Redirect URL for the short link |
Request Example
{
"lUrl": "https://super-apps.ai"
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"sUrl": "/s/4c2zF4" // Short link address, requires manual domain concatenation
},
"traceid": "1ed1bf74c77745ac9ddde22247f7d157"
}
# 2. Member-View
# 2.1 Get Trial User List
Request URL
GET /api/v1/open/dev/trial-user/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: query
| Field | Type | Description |
|---|---|---|
| keyword | string | Fuzzy search keyword |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"createTime": 1723529917125, // Creation time. Millisecond timestamp
"updateTime": 1723529917125, // Update time. Millisecond timestamp
"userId": "13000000000" // Identifier of the trial user
},
"total": 1 // Total count
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 2.2 Get Account Role List
Request URL
GET /api/v1/open/dev/account/role/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: query
| Field | Type | Description |
|---|---|---|
| accountId | string | |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"builtinRoleKey": "admin", // Key of the built-in role. Existing: admin, data_analyst, developer, super_admin
"name": "", // Role name
"roleId": "2309190518900000" // Role ID
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 2.3 Get Organization Member List
Request URL
GET /api/v1/open/dev/member/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: query
| Field | Type | Description |
|---|---|---|
| keyword | string | |
| pageNo | int | |
| pageSize | int | |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"members": {
"account": "", // Account name
"accountId": "", // Account ID
"createTime": 1, // Creation time
"email": "", // Email
"isAdmin": 1, // Whether the user is an organization admin. 0=No, 1=Yes
"memberId": "", // Member ID of the current account within the organization
"organId": "", // Organization ID
"phone": "", // Account phone number
"platform": 1, // User platform. 1=Developer Center, 2=Digital Center. This interface always returns 1
"roleList": { // Role list
"builtinRoleKey": "",
"name": "",
"roleId": ""
},
"status": 1 // Status. 0: Normal, 1: Frozen
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3. Member - Edit
# 3.1 Remove Organization Member
Request URL
POST /api/v1/open/dev/member/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| memberIds | string[] | IDs of members to be removed |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3.2 Generate Invite Organization Member Link Request
Request URL
POST /api/v1/open/dev/organ/invite-token
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| apiServer | string | Domain address of the link, e.g., https://super-apps.ai |
| expireTime | int | Future expiration time, in milliseconds, e.g., 1756539106902 |
| neverExpire | bool | Whether expiration is allowed, true: never expires; false: allows expiration |
| singleUse | bool | Whether multiple uses are allowed, true: single-use; false: multiple uses |
| roleIds | []string | Role IDs, obtainable via the API /api/v1/open/dev/role/list |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"inviteToken": "8cb7128ae8414e6f92c79802131e8a65",
"shortUrl": "/s/3CkrQB" // Short link, needs to be concatenated with apiServer for use
},
"traceid": "787d42e3623848a9b0600475602e99c4"
}
# 4. Role - View
# 4.1 Get Account List Under Role
Request URL
GET /api/v1/open/dev/role/account/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| roleId | string | Role ID |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"accounts": {
"account": "", // Account name
"accountId": "", // Account ID
"createTime": 1, // Account creation time
"email": "", // Email
"phone": "" // Phone number
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 4.2 Get Role List
Request URL
GET /api/v1/open/dev/role/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
| keyword | string | Keyword for fuzzy search by role name |
Example Response
{
"errcode": "",
"error": "",
"data": {
"items": [
{
"name": "", // Role name
"roleId": "", // Role ID
"isBuiltin": false, // Whether it is a built-in role
"accountCount": 1, // Number of members under the role
"createTime": 1723529917125,
"update_time": 1723529917125
}
],
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5. Role - Edit
# 5.1 Delete Role
Request URL
POST /api/v1/open/dev/role/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| roleId | string | Role ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.2 Bind Account to Role
Note
Each request contains the full list of roles, and the old relationships will be deleted.
Request URL
POST /api/v1/open/dev/account/role/binding
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| accountId | string | Account ID |
| roleIds | string[] | List of role IDs assigned to the account |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.3 Remove Account from Role
Request URL
POST /api/v1/open/dev/role/account/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| accountIds | string[] | List of member IDs to be removed |
| roleId | string | Role ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.4 Bind Account to Role
Note
Each request only contains an incremental member list and will not delete existing relationships.
Request URL
POST /api/v1/open/dev/role/account/binding
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| accountIds | string[] | List of member IDs |
| roleId | string | Role ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.5 Update Role
Request URL
POST /api/v1/open/dev/role/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| idePermissionTree | Map<string, object> | IDE Permission Tree |
| permissionTree | Map<string, object> | Management Console Permission Tree |
| roleId | string | Role ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.6 Create Role
Request URL
POST /api/v1/open/dev/role/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| idePermissionTree | Map<string, object> | IDE Permission Tree |
| permissionTree | Map<string, object> | Management Console Permission Tree |
| roleName | string | Role Name |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"roleId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6. Mini-Program - View
# 6.1 Get Resource Group List for Current Organization
Request URL
GET /api/v1/open/dev/resource-group/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| groupId | string | Filter by resource group ID |
| platform | int | Platform type: 1=Development Server, 2=Digital End |
| pageNo | int | Page number, starting from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"groups": {
"createTime": 1, // Creation time
"groupId": "", // Resource group ID
"name": "", // Resource group name
"roleId": "", // Bound role ID
"organId": "", // Organization ID
"status": 1, // Status: 1=Normal, 2=Disabled
"updateTime": 1 // Update time
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.2 Get Mini-Program List
Request URL
GET /api/v1/open/dev/mini-apps/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| appStatus | string | Multiple selection, comma-separated. 1=Published, 2=Unpublished, 3=Unpublished, 4=Unpublishable, 5=Unavailable |
| keyword | string | Fuzzy search keyword. Mini-Program name |
| pageNo | int | Page number, starting from 1 |
| pageSize | int | Number of items per page |
| projectType | string | Multiple selection, comma-separated. 1=Mini-Program, 2=Mini-Game, 3=H5, 4=Widget, 5=Low Power |
| sortType | string | Sorting method 1. created: Ascending by creation time 2. -created: Descending by creation time 3. updated: Ascending by update time 4. -updated: Descending by update time |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"appClass": "", // i18n translation of Mini-Program category
"appClassKey": "", // Unique key of Mini-Program category
"createTime": 1, // Creation time
"desc": "", // Description
"displayLang": "zh",
"displayStatus": 1, // 1=Published, 2=Unpublished, 3=Unpublished, 4=Unpublishable, 5=Unavailable
"isForbidden": true, // Whether it is disabled
"logo": "2229372745009605", // Logo image network disk ID, needs to be concatenated, domain+/api/v1/mop/runtime/download/{logo}, e.g., https://super-apps.ai/api/v1/mop/runtime/download/2229372745009605
"miniAppId": "", // Mini-Program ID
"name": "", // Mini-Program name
"organId": "", // Organization ID to which the Mini-Program belongs
"organName": "", // Organization name to which the Mini-Program belongs
"projectType": 1, // Mini-Program subtype. 1=Mini-Program, 2=Mini-Game, 3=H5, 4=Widget, 5=Low Power
"status": 1, // Current lifecycle status of the Mini-Program. 1=Under development, code package not uploaded, 2=Pending review for publishing, 3=Review for publishing withdrawn, 4=Review for publishing approved, 5=Review for publishing rejected, 6=Published, 7=Unpublished (initiated by developer), 8=Unpublished (by operations admin), 9=Under development, only code package uploaded, 10=Pending review for creation, 11=Review for creation withdrawn, 12=Review for creation rejected
"updateTime": 1 // Update time
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.2 Get Mini-Program QR Code
Request URL
POST /api/v1/open/dev/mini-apps/qr-code/fetch
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| apiServer | string | Main server address |
| miniAppId | string | Mini-Program ID |
| type | int | QR code type: 1=Review version QR code, 2=Experience version QR code, 3=Temporary version QR code, 4=Online version QR code, 5=Real device debugging version QR code, 6=Latest submitted development version |
| startParams | object | Parameter information JSON, e.g., {"path": "pages/API/index/index","query": "a=1&b=2"} |
| expireTime | int | Expiration time in seconds. This field can only be used for the latest submitted development version; for others, the review version has a fixed expiration of 3 minutes, and the temporary version & real device debugging version have a fixed expiration of 6 hours |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"expireTime":1750404869000, // Expiration time in milliseconds, 0 means permanent validity
"url": "https://fc-testing.finogeeks.club/api/v1/mop/runtime/applet/-f-6b8371c76de54d87--"
},
"traceid": "36bf5bc583614024b71d830980a8d660"
}
# 6.3 Get Mini-Program Details
Request URL
GET /api/v1/open/dev/mini-apps/{miniAppId}
Request Parameters Parameter Location: path
| Field | Type | Description |
|---|---|---|
| miniAppId | string | Mini-Program ID |
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"appClass": "", // Mini-Program category
"appClassKey": "", // Mini-Program category key
"createBy": "", // Creator
"createTime": 1, // Creation time
"creatorAccount": "", // Creator account
"desc": "", // Mini-Program description
"detailDesc": "", // Mini-Program detailed description
"displayLang": "", // Mini-Program display language
"isForbidden": true, // Whether it is disabled
"logo": "", // Mini-Program logo
"miniAppId": "", // Mini-Program ID
"name": "", // Mini-Program name
"organId": "", // Organization ID to which the Mini-Program belongs
"organName": "", // Organization name to which the Mini-Program belongs
"privacySettingType": 1, // Mini-Program privacy setting status. 0=Not set, 1=Custom content set, 2=Default content set
"projectType": 1, // Mini-Program subtype. 1=Mini-Program, 2=Mini-Game, 3=H5, 4=Widget, 5=Low Power
"searchable": true, // Whether search is allowed
"status": 1, // Current lifecycle status of the Mini-Program. 1=Under development, code package not uploaded, 2=Pending review for publishing, 3=Review for publishing withdrawn, 4=Review for publishing approved, 5=Review for publishing rejected, 6=Published, 7=Unpublished (initiated by developer), 8=Unpublished (by operations admin), 9=Under development, only code package uploaded, 10=Pending review for creation, 11=Review for creation withdrawn, 12=Review for creation rejected
"testInfo": 1, // Mini-Program test information
"updateTime": 1, // Update time
"version": "" // Published version number
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7. Mini-Program - Edit
# 7.1 Bind/Unbind a Mini-Program to/from a Resource Group
Request URL
POST /api/v1/open/dev/resource-group/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| resourceGroupId | string | Resource group ID |
| hostAppIds | []string | List of Host-App IDs |
| miniAppIds | []string | List of Mini-Program IDs |
Request Example
{
"hostAppIds": [],
"miniAppIds": [],
"resourceGroupId": "2793488298272837"
}
Example Response
{
"errcode": "OK",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.2 Add Members to a Resource Group
Request URL
POST /api/v1/open/dev/resource-group/account/add
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| resourceGroupId | string | Resource group ID |
| accountIds | []string | List of account IDs to add to the resource group |
Request Example
{
"resourceGroupId": "2923919726494277",
"accountIds": [
"2722814788530949"
]
}
Example Response
{
"errcode": "OK",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.3 Remove Members from a Resource Group
Request URL
POST /api/v1/open/dev/resource-group/account/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| resourceGroupId | string | Resource group ID |
| accountIds | []string | List of account IDs to remove from the resource group |
Request Example
{
"resourceGroupId": "2923919726494277",
"accountIds": [
"2722814788530949"
]
}
Example Response
{
"errcode": "OK",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.4 Create a Mini-Program
Request URL
POST /api/v1/open/dev/mini-apps/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| detailDesc | string | Detailed description of the Mini-Program |
| logo | string | Mini-Program logo |
| name | string | Mini-Program name |
| projectType | int | Mini-Program subtype. 1=Mini-Program 2=Mini-Game 3=H5 4=Widget 5=Low-Power |
| appClassKey | string | Mini-Program category |
| desc | string | Brief description of the Mini-Program |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"appClass": "", // i18n translation of the Mini-Program category
"appClassKey": "", // Unique key for the Mini-Program category
"createBy": "", // Creator user ID
"createTime": 1, // Creation timestamp
"creatorAccount": "", // Creator account name
"desc": "", // Mini-Program description
"detailDesc": "", // Detailed description of the Mini-Program
"isForbidden": true, // Whether the Mini-Program is disabled
"logo": "", // Mini-Program logo
"miniAppId": "", // Mini-Program ID
"name": "", // Mini-Program name
"organId": "", // Organization ID the Mini-Program belongs to
"organName": "", // Organization name the Mini-Program belongs to
"privacySettingType": 1, // Mini-Program privacy setting status. 0=Not set 1=Custom content set 2=Default content set
"projectType": 1, // Mini-Program subtype. 1=Mini-Program 2=Mini-Game 3=H5 4=Widget 5=Low-Power
"searchable": true, // Whether the Mini-Program is searchable
"status": 1, // Current lifecycle status of the Mini-Program. 1=In development, code package not uploaded 2=Pending review for listing 3=Listing review withdrawn 4=Listing review approved 5=Listing review rejected 6=Listed 7=Delisted (initiated by developer) 8=Delisted (initiated by operations admin) 9=In development, code package uploaded only 10=Pending creation review 11=Creation review withdrawn 12=Creation review rejected
"updateTime": 1, // Update timestamp
"version": "" // Published version number
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.2 Update a Mini-Program
Request URL
POST /api/v1/open/dev/mini-apps/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| name | string | Mini-Program name |
| appClassKey | string | Unique key for the Mini-Program category |
| desc | string | Brief description |
| detailDesc | string | Detailed description of the Mini-Program |
| logo | string | Logo |
| miniAppId | string | Mini-Program ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.3 Disable/Enable a Mini-Program
Request URL
POST /api/v1/open/dev/mini-apps/forbid
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| isForbidden | bool | Whether to disable |
| miniAppId | string | Mini-Program ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.4 Upload a Mini-Program Logo
Request URL
POST /api/v1/open/dev/mini-apps/logo/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter Location: body form-data
| Field | Type | Description |
|---|---|---|
| file | file | File |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"netdiskID": "2357371467212229", // File ID, can be used in the logo field during creation or update
},
"traceid": "c3d1cf08389947dab3623125006eb39c"
}
# 7.5 Update Mini-Program Privacy Settings
Request URL
POST /api/v1/open/dev/mini-apps/privacy-setting/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| miniAppId | string | Mini-Program ID |
| commitType | int | Submission type, default is 1. Optional values: 1=The developer of this Mini-Program promises and guarantees that no user information has been processed in any way. If user information is processed in the future, the "Mini-Program Privacy Protection Guide" will be updated promptly. 2=This Mini-Program processes user information and will truthfully fill in and promptly update the user information processing status. |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
},
"traceid": "c3d1cf08389947dab3623125006eb39c"
}
# 8. Mini-Program Version - View
# 8.1 Get the Latest Version Information of a Mini-Program
Request URL
GET /api/v1/open/dev/mini-apps/versions/latest
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| miniAppId | string | Mini-Program ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"onlineVersion": { // Online version information
"miniAppVersionId": "2329398106793477", // Mini-Program version ID
"miniAppId": "fc2329386816071045", // Mini-Program ID
"name": "翻译测试", // Mini-Program version snapshot name
"logo": "2329064445187589", // Mini-Program version snapshot logo
"version": "1.0.0", // Mini-Program version number
"desc": "中文简介", // Mini-Program version snapshot description
"detailDesc": "中文描述", // Mini-Program version snapshot detailed description
"appClassKey": "zixun", // Mini-Program version snapshot category key
"appClass": "资讯", // i18n translation corresponding to the Mini-Program version snapshot category key
"status": 6, // Current lifecycle status of the Mini-Program. 1=In development, code package not uploaded 2=Pending review for listing 3=Listing review withdrawn 4=Listing review approved 5=Listing review rejected 6=Listed 7=Delisted (by developer) 8=Delisted (by admin) 9=In development, only code package uploaded 10=Pending creation review 11=Creation review withdrawn 12=Creation review rejected
"autoPub": false, // Whether to auto-publish
"inGrayRelease": false, // Whether in gray release
"miniAppCompiledPackageId": "2329397929420294", // Code package ID corresponding to the Mini-Program version
"isRollback": false, // Whether it is a rollback version
"organId": "2309190519194821",
"creatorAccount": "宝树", // Account name of the creator
"versionDescription": "e", // Description when uploading the code package via IDE
"sequence": 1, // The sequence number of this version among all versions of the Mini-Program
"createTime": 1724311579430, // Version creation time
"updateTime": 1724311641102, // Version update time
},
"reviewVersion": null, // Review version information. Fields are identical to onlineVersion
"trailVersion": { // Trial version information
"miniAppCompiledPackageId": "2329600587148550",
"compiledPackageType": 2,
"versionEditionStatus": 3,
"miniAppId": "fc2329386816071045",
"organId": "2309190519194821",
"userId": "2309190518932677",
"createBy": "2309190518932677",
"creatorAccount": "宝树",
"sourceFiles": [
],
"versionDescription": "",
"createTime": 1724323937836,
"version": "4.0.0",
"startParams": {
"pathAndQuery": ""
},
"trialVersionTime": 0,
"frameworkInfo": null,
"supportFtpkg": true,
"versionAuditStatus": 0,
"versionAuditStatusRelatedMiniAppVersionId": ""
},
"wechatQrcode": null,
"uploadedCompiledPackages": true
},
"traceid": "1f0ad85c0da74adb9ed5f628ead39731"
}
# 8.2 Get the List of Mini-Program Code Packages
Request URL
GET /api/v1/open/dev/mini-apps/compiled-package/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| miniAppId | string | Mini-Program ID |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": [
"compiledPackageType": 1, // Status: 1: Not set as trial version, 2: Set as trial version
"createBy": "",
"createTime": 1,
"creatorAccount": "",
"frameworkInfo": 1,
"miniAppCompiledPackageId": "", // Code package ID
"miniAppId": "", // Mini-Program ID
"organId": "", // Tenant ID
"sourceFiles": {
"encryptPackages": {
"fileMd5": "",
"fileUrl": "",
"filename": "",
"ftpkgSha256": "",
"ftpkgUrl": "",
"independent": true,
"name": "",
"pages": [
""
],
"root": ""
},
"encryptedFileMd5": "",
"encryptedFileSha256": "",
"encryptedUrl": "",
"fileMd5": "",
"ftpkgSha256": "",
"ftpkgUrl": "",
"name": "",
"packageConfig": {
"fields": {
"kind": ""
}
},
"packages": {
"fileMd5": "",
"fileUrl": "",
"filename": "",
"ftpkgSha256": "",
"ftpkgUrl": "",
"independent": true,
"name": "",
"pages": [
""
],
"root": ""
},
"sourceFileUrl": "",
"uploadDate": 1,
"url": ""
},
"startParams": {
"pathAndQuery": "" // Startup parameters
},
"trialVersionTime": 1, // Time when set as trial version
"version": "v1.0.0", // Version number
"versionDescription": "desc" // Version description
],
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 8.3 Get Mini-Program Version Audit Information (Query by versionId)
Request URL
GET /api/v1/open/dev/mini-apps/audit/versions/:miniAppVersionId
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| miniAppVersionId | string | Mini-Program version ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"miniAppAuditId": "3246622773920390", // Audit ID
"miniAppVersionId": "3246622773920389", // Mini-Program version ID
"miniAppId": "fc2326558011181381",
"auditStatus": 2, // Audit status: 2: Under review, 3: Review withdrawn, 3: Review approved, 4: Review rejected
"applyId": "2309202655986885", // Applicant ID
"createTime": 1780294530298,
"updateTime": 1780294530298,
"miniAppAuditType": 1, // Mini-Program audit method, 1: Self-audit in Mini-Program Development Center, 2: Audit by Digital Center
"workflowInstanceId": "3246622773985413", // Audit workflow instance ID
"nodes": [ // Audit node information
{
"nodeName": "通用审批",
"nodeId": "3246622774018181"
}
]
},
"traceid": "0f4aaf97418445779e1533376c7331b5"
}
# 9. Mini-Program Version - Editing
# 9.1 Update the Page Path of a Code Package
Request URL
POST /api/v1/open/dev/mini-apps/compiled-package/path-and-query/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| miniAppCompiledPackageId | string | Code package ID |
| pathAndQuery | string | Startup path for the trial version |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.2 Rollback Mini-Program Version
Request URL
POST /api/v1/open/dev/mini-apps/versions/rollback
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppVersionId | string | Mini-Program version ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.3 Cancel Trial Version of Code Package
Request URL
POST /api/v1/open/dev/mini-apps/compiled-package/trial/cancel
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppCompiledPackageId | string | Mini-Program code package ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.4 Set Code Package as Trial Version
Request URL
POST /api/v1/open/dev/mini-apps/compiled-package/trial/set
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppCompiledPackageId | string | Mini-Program code package ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.5 Unpublish Mini-Program Online Version
Request URL
POST /api/v1/open/dev/mini-apps/versions/unpublish
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppVersionId | string | Mini-Program version ID |
| statusReason | string | Reason for unpublishing |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.6 Withdraw Review Version Application
Request URL
POST /api/v1/open/dev/mini-apps/versions/review/withdraw
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppVersionId | string | Mini-Program version ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.7 Submit for Review
Request URL
POST /api/v1/open/dev/mini-apps/versions/review/submit
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| operAdminAudit | bool | Whether to designate admin review on the digital end |
| testInfo | object | Test information |
| autoPub | bool | Whether to automatically publish after review approval |
| miniAppCompiledPackageId | string | Code package ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"miniAppVersionId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9.8 Publish Reviewed Version
Request URL
POST /api/v1/open/dev/mini-apps/versions/publish
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| miniAppVersionId | string | Mini-Program version ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 10. Mini-Program Unified Authentication
# 10.1 Development End - Mini-Program Unified Login - Get Phone Number
Request URL
POST /api/v1/open/dev/mini-apps/unified-auth/phone/get
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| appId | string | Mini-Program ID |
| code | string |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"phone": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 10.2 Dev - Mini-Program Unified Login
Request URL
POST /api/v1/open/dev/mini-apps/unified-auth/login
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| code | string | |
| appId | string | Mini-Program ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"accessToken": "",
"channel": "", // Channel
"openId": "",
"unionId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 10.3 Dev - Mini-Program Unified Login - Get User Info
Request URL
POST /api/v1/open/dev/mini-apps/unified-auth/userinfo
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Description |
|---|---|---|
| accessToken | string | |
| appId | string | Mini-Program ID |
| channel | string | Channel |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"account": "",
"email": "",
"phone": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11. Mini-Program Code Package
# 11.1 Upload Mini-Program Code Package
Request URL
POST /api/v1/open/dev/mini-apps/compiled-package/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter location: body, formdata format
| Field | Type | Description |
|---|---|---|
| file | file | Uploaded code package file |
Example Response
{
"error": "",
"errcode": "OK",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.2 Create New Mini-Program Code Package Object
Request URL
POST /api/v1/open/dev/mini-apps/compiled-package/build
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
{
"miniAppId": "fc11111111111", // Mini-Program ID
"version": "1.0.4", // Mini-Program Version
"versionRemark": "1.0.4", // Version Description
"username": "pjf01", // Uploader Username
"basicPackVer": "", // Keep empty
"packages": [ // Copy the content of packageConfig.json from the subpackage directory of the IDE exported code package directory
{
"root": ".",
"name": "__APP__",
"pages": [
"pages/component/index/index",
"pages/API/index/index",
"pages/component/view/view",
"pages/component/scroll-view/scroll-view"
],
"independent": false,
"filename": "__APP__.zip"
},
{
"root": "packageAPI",
"name": "34f98750f03c6a2bed1f2f4de2bbb7b9",
"pages": [
"packageAPI/pages/get-network-type/get-network-type",
"packageAPI/pages/on-network-status-change/on-network-status-change",
"packageAPI/pages/get-system-info/get-system-info",
"packageAPI/pages/make-phone-call/make-phone-call"
],
"independent": false,
"filename": "34f98750f03c6a2bed1f2f4de2bbb7b9.zip"
}
],
"packageConfig": { // Copy the content of packageExtConfig.json from the subpackage directory of the IDE exported code package directory
"isLazyLoading": false,
"entryPagePath": "pages/component/index/index"
},
"filesFromNetdisk": [
{
"name": "app.zip", // Full package file name
"netdiskID": "2340709818004869" // Netdisk ID returned from step 2 for the full package upload
},
{
"name": "__APP__.zip", // Subpackage 1 file name
"netdiskID": "2340709821396357" // Netdisk ID returned from step 2 for subpackage 1 upload
},
{
"name": "34f98750f03c6a2bed1f2f4de2bbb7b9.zip", // Subpackage 2 file name
"netdiskID": "2340709822559621" // Netdisk ID returned from step 2 for subpackage 2 upload
}
]
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.3 Upload Mini-Program Plugin Logo
Request URL
POST /api/v1/open/dev/plugin/logo/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter location: body, formdata format
| Field | Type | Description |
|---|---|---|
| file | file | Uploaded code package file |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"netdiskID": "" // Netdisk ID
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.4 Create New Mini-Program Plugin
Request URL
POST /api/v1/open/dev/plugins/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
{
"name": "Video Plugin", // Plugin Name
"imageNetDiskId": "2340709818004869", // Plugin image netdisk ID, obtained using the 11.3 API upload
"introduce": "A plugin for playing videos", // Plugin Introduction
"devDocAddr": "http://wwww......" // Plugin Development Documentation URL
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"createTime": 1745827165000, // Creation Time
"creatorAccount": "zhangsan", // Creator
"devDocAddr": "http://wwww......", // Plugin Development Documentation URL
"imageNetDiskId": "2340709818004869", // Plugin Image Netdisk ID
"introduce": "A plugin for playing videos", // Plugin Introduction
"name": "Video Plugin", // Plugin Name
"organId": "", // Organization ID
"organName": "", // Organization Name
"platform": 1, // 1: Dev, 2: Operations
"pluginId": "", // Plugin ID
"pubTime": 0, // Publish Time
"updateTime": 0 // Update Time
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.5 Upload Mini-Program Plugin Code Package
Request URL
POST /api/v1/open/dev/plugin/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter location: body, formdata format
| Field | Type | Description |
|---|---|---|
| file | file | Uploaded code package file |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"netdiskID": "" // Netdisk ID
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.6 Create Mini-Program Plugin Version
Request URL
POST /api/v1/open/dev/plugins/versions/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
{
"pluginId": "2340709818004869", // Plugin ID, obtained using the 11.4 API
"version": "1.0.0", // Plugin version
"updateLog": "Plugin for playing videos", // Plugin version update log description
"codePackageUrl": "2340709818004869", // Plugin code package cloud disk ID, obtained using the 11.5 API
"ext": "" // Extension content
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.7 Query Mini-Program Plugin Version Information
Request URL
GET /api/v1/open/dev/plugins/version/get
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| pluginId | string | Mini-Program Plugin ID |
| version | string | Plugin version |
Example Request
/api/v1/open/dev/plugins/version/get?pluginId=2340709818004869&version=1.0.0
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"codePackageUrl": "", // Plugin code package cloud disk ID
"createBy": "", // Creator ID
"createTime": 0, // Creation time
"creatorAccount": "", // Creator account
"pluginId": "", // Plugin ID
"pluginVersionId": "", // Plugin version ID
"pubTime": 0, // Publish time
"sequence": 0, // Sequence number
"updateLog": "", // Plugin update log
"updateTime": 0, // Update time
"version": "" // Plugin version
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 11.8 Download Mini-Program Plugin Code Package
Request URL
GET /api/v1/open/dev/plugin/code/download/:netdiskId
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| netdiskId | string | Plugin code package cloud disk ID |
Example Request
/api/v1/open/dev/plugin/code/download/2340709818004869
Example Response
File content
# 12. Mini-Program Message Subscription
# 12.1 Get Available Templates for Current Mini-Program
Request URL
GET /api/v1/open/dev/mini-apps/message-delivery/templates/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| miniAppId | string | Mini-Program ID |
Example Request
/api/v1/open/dev/mini-apps/message-delivery/templates/list?miniAppId=fcxxxx
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": [
{
"messageDeliveryTemplateId": "12121", // Template ID
"subscribeType": 1, // Subscription type 1=One-time 2=Permanent
"title": "template title", // Template title
"formatText": "Your order will be delivered by {{orderExpectTime}}", // Message template
"link": "https://xx.com",
"desc": "this is desc",
"status": 1, // Status 1=Enabled 2=Disabled 3=Digital Center-Disabled
"createTime": 1745827165000,
"update_time": 1745827165000,
"params": [{
"keyword": "orderExpectTime", // Variable keyword
"type": "6", // Parameter type 1=Letter 2=Symbol 3=String 4=Number 5=Thing 6=Time 7=Amount 8=Status
"paramSample": "2025/05/01"
}]
}
]
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 12.2 Push Mini-Program Message Template
Request URL
POST /api/v1/open/dev/mini-apps/message-delivery/notify/push
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
{
"miniAppId": "fcxxxxx", // ID of the Mini-Program initiating the push
"openId": "2696151317266949", // The user's unique identifier under the Mini-Program, openId, used to identify the user. Refer to the /api/v1/open/dev/mini-apps/unified-auth/login API for acquisition method
"templates": [{
"messageDeliveryTemplateId": "1119892", // Template ID
"channelCodes": ["notify", "sms"], // Push application channels
"params": [
{
"keyword": "orderExpectTime", // Template variable
"value": "2025/05/01" // Value corresponding to the template variable
}
]
}]
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 13. Application - View
# 13.1 Get Host-App List
Request URL
GET /api/v1/open/dev/host-apps/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"bundleIdPublic": true, // Whether bundleId is visible to other teams
"createTime": 1, // Creation time
"desc": "", // Description
"hostAppId": "", // Host-App ID
"hostAppPublic": true, // Whether the Host-App is visible to other teams
"logo": "", // Host-App logo
"name": "", // Name
"organId": "", // Tenant ID
"organName": "", // Tenant name
"owner": "", // Application owner
"platform": 1, // Application platform 1=Developer Center 2=Digital Center
"source": 1, // Source 1=Current organization's own application from Developer Center 2=Application created by other organizations in Developer Center 3=Digital Center
"status": 1, // Status 1=Enabled 2=Disabled
"updateTime": 1 // Update time
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 13.2 Development Side - Get Host-App Configuration
Request URL
GET /api/v1/open/dev/host-apps/config
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters None
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"activeBundleIdLimitPerHostApp": 1, // Number of bundles each Host-App can have (active status)
"bundleIdLimitPerHostApp": 1, // Number of bundles each Host-App can have (any status)
"canConfiguredHostAppPublic": true, // Whether the Host-App can be configured as visible to other teams
"remainCreateHostAppCount": 1 // Number of apps that can still be created
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14. Application - Edit
# 14.1 Create Application
Request URL
POST /api/v1/open/dev/host-apps/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| desc | string | Description |
| hostAppPublic | bool | Whether the Host-App is visible to other teams |
| logo | string | Logo |
| name | string | Name |
| owner | string | Owning Enterprise |
| bundleIdPublic | bool | Whether the bundleId is visible to other teams |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"hostAppId": "" // Application ID
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14.2 Update Application
Request URL
POST /api/v1/open/dev/host-apps/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| logo | string | Logo |
| name | string | Name |
| owner | string | Owning Enterprise |
| bundleIdPublic | bool | Whether the bundleId is visible to other teams |
| desc | string | Description |
| hostAppId | string | Host-App ID |
| hostAppPublic | bool | Whether the Host-App is visible to other teams |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14.3 Associate Application and Mini-Program
Request URL
POST /api/v1/open/dev/host-apps/mini-apps/associate
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| hostAppId | string | Host-App ID |
| miniAppIds | string[] | List of Mini-Program IDs |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14.4 Update Application Status
Request URL
POST /api/v1/open/dev/host-apps/change-status
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| status | int | Status 0-All 1=Enabled 2=Disabled |
| hostAppId | string | Application ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14.5 Disassociate Application and Mini-Program
Request URL
POST /api/v1/open/dev/host-apps/mini-apps/disassociate
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| hostAppId | string | Host-App ID |
| miniAppIds | string[] | Mini-Program ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 14.5 Upload Application Logo
Request URL
POST /api/v1/open/dev/host-apps/logo/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter Location: body form-data
| Field | Type | Description |
|---|---|---|
| file | file | File |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"netdiskID": "2357371467212229", // File ID, can be filled in the logo field when creating or updating
},
"traceid": "c3d1cf08389947dab3623125006eb39c"
}
# 15. Custom API - View
# 15.1 Get Application API List
Request URL
GET /api/v1/open/dev/host-apps/apis/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| apiCategory | string | Custom API category. Optional parameter for filtering |
| hostAppId | string | Application ID |
| apiScope | int | API scope 1--Public 2--Private |
| state | int | API status 0=All 1=Disabled 2=Enabled |
| searchText | string | Fuzzy search text |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"apiCategory": [ // Category
""
],
"apiDescription": "", // Description
"apiManageId": "", // API ID
"apiName": "", // API Name
"apiScope": 1, // API scope 1--Public 2--Private
"createTime": 1, // Creation time
"hostAppId": "", // ID of the owning application
"state": 1, // API status 0=All 1=Disabled 2=Enabled
"updateTime": 1 // Update time
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 16. Custom API - Edit
# 16.1 Development End - Update Host-App API
Request URL
POST /api/v1/open/dev/host-apps/apis/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| apiCategory | string array | API category |
| apiDescription | string | API description |
| apiManageId | string | API unique ID |
| apiName | string | API name |
| apiScope | object | API scope: 1 - Public, 2 - Private |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 16.2 Development End - Enable/Disable Custom API
Request URL
POST /api/v1/open/dev/host-apps/apis/change-status
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| apiManageIds | string[] | List of API IDs |
| state | int | Status: 1 - Disabled, 2 - Enabled |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 16.3 Development End - Create Host-App API
Request URL
POST /api/v1/open/dev/host-apps/apis/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| hostAppId | string | Application ID |
| apiCategory | string[] | API category |
| apiDescription | string | API description |
| apiName | string | API name |
| apiScope | int | API scope: 1 - Public, 2 - Private |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"apiCategory": [
""
],
"apiDescription": "",
"apiManageId": "",
"apiName": "",
"apiScope": 1,
"createTime": 1,
"hostAppId": "",
"state": 1,
"updateTime": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 17. Custom Menu - View
# 17.1 Developer Center - Get Custom Menu Category List
Request URL
GET /api/v1/open/dev/host-apps/custom-menus/categories
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters None
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": [
""
]
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 17.2 Development End - Get Host-App Custom Menu List
Request URL
GET /api/v1/open/dev/host-apps/custom-menus/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| hostAppId | string | Application ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"category": [ // Menu category
""
],
"createTime": 1, // Creation time
"customMenuId": "", // Menu ID
"darkImageUrl": "", // Menu logo for Dark Mode
"hostAppId": "", // Host-App ID
"imageUrl": "", // Menu logo
"infoId": "", // Menu info ID
"isSdkBuiltin": 1, // Whether it is a built-in menu: 1=No, 2=Yes
"name": "", // Menu name
"scope": 1, // Scope: 1 - Public, 2 - Private
"sortNum": 1, // Menu sort order
"state": 1, // Status: 1 - Disabled, 2 - Enabled
"updateTime": 1 // Update time
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18. Custom Menu - Edit
# 18.1 Development End - Disable/Enable Custom Menu
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/change-status
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| customMenuIds | string[] | List of custom menu unique IDs |
| state | int | Status: 1 - Disabled, 2 - Enabled |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18.2 Development End - Update Host-App Custom Menu
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| state | Int | Status: 1 - Disabled, 2 - Enabled |
| category | string[] | Icon category |
| customMenuId | string | Menu ID |
| darkImageUrl | string | Image for Dark Mode |
| imageUrl | string | Image |
| infoId | string | Unique ID |
| name | string | Name |
| scope | object | Scope: 1=Public, 2=Private |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18.3 Development Side - Create Host-App Custom Menu
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| scope | int | Scope: 1=Public, 2=Private |
| category | string[] | Icon Category |
| darkImageUrl | string | Dark Mode Image Netdisk ID |
| hostAppId | string | |
| imageUrl | string | Image Netdisk ID |
| infoId | string | |
| name | string |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"category": [
""
],
"createTime": 1,
"customMenuId": "",
"darkImageUrl": "",
"displayLang": "",
"hostAppId": "",
"imageUrl": "",
"infoId": "",
"isSdkBuiltin": 1,
"name": "",
"scope": 1,
"sortNum": 1,
"state": 1,
"updateTime": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18.4 Development Side - Sort Host-App Custom Menus
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/sort
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| customMenuId | string | Menu ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18.5 Development Side - Check if Host-App Custom Menu Exists
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/check-exist
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| checkType | int | Check Type: 1=name, 2=infoId |
| customMenuId | string | |
| hostAppId | string | |
| text | string | Text to check. Determined by checkType |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"exist": true
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 18.6 Upload Custom Menu Logo
Request URL
POST /api/v1/open/dev/host-apps/custom-menus/logo/upload
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
| Content-Type | multipart/form-data |
Request Parameters Parameter Location: body form-data
| Field | Type | Description |
|---|---|---|
| file | file | File |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"netdiskID": "2357371467212229", // File ID, can be used in the logo field when creating or updating
},
"traceid": "c3d1cf08389947dab3623125006eb39c"
}
# 19. Analytics
# 19.1 Data Dashboard - Access Count
Request URL
GET /api/v1/open/dev/stat/basic/billboard/total/pv
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 19.2 Data Dashboard - Get Mini-Program Statistics Line Chart
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/pillar
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | Grayscale End Time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Grayscale Start Time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | Data Item List |
| items.activeDeviceCount | integer | Active Device Count |
| items.date | string | Date |
| items.dateMs | integer | Date Timestamp (Milliseconds) |
| items.deviceCount | integer | Device Count |
| items.duration | integer | Usage Duration (Seconds) |
| items.newDeviceCount | integer | New Device Count |
| items.openCount | integer | Open Count |
| items.val | integer | Value |
| maxTotal | integer | Maximum Total |
Example Response
{
"items": [
{
"activeDeviceCount": 100,
"date": "2024-01-01",
"dateMs": 1704067200000,
"deviceCount": 500,
"duration": 3600,
"newDeviceCount": 50,
"openCount": 200,
"val": 1000
}
],
"maxTotal": 5000
}
# 19.3 Data Dashboard - Total Average Visit Duration
Request URL
GET /api/v1/open/dev/stat/basic/billboard/total/avg-duration
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| hasData | boolean | Whether data exists |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 19.4 Data Dashboard - Total Active Devices
Request URL
GET /api/v1/open/dev/stat/basic/billboard/total/active-device
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| hasData | boolean | Whether data exists |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 19.5 Data Dashboard - Total UV
Request URL
GET /api/v1/open/dev/stat/basic/billboard/total/uv
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| hasData | boolean | Whether data exists |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 19.6 Data Dashboard - Host-App Source
Request URL
GET /api/v1/open/dev/stat/basic/billboard/host-app
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "App Name",
"proportion": "50%",
"value": 1000
}
]
}
# 19.7 Data Dashboard - Geographic Distribution
Request URL
GET /api/v1/open/dev/stat/basic/billboard/country/region
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End Time |
| isRunPlay | boolean | No | query | Is Run Play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start Time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "Beijing",
"proportion": "50%",
"value": 1000
}
]
}
# 19.8 Device Data - Get Mini-Program Retention Statistics
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/retention
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (ms) |
| items.five | integer | 5-day retention |
| items.formattedVal | string | Formatted value |
| items.four | integer | 4-day retention |
| items.fourteen | integer | 14-day retention |
| items.newUserCount | integer | New user count |
| items.one | integer | Next-day retention |
| items.seven | integer | 7-day retention |
| items.six | integer | 6-day retention |
| items.thirty | integer | 30-day retention |
| items.three | integer | 3-day retention |
| items.two | integer | 2-day retention |
| items.val | integer | Value |
Example Response
{
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"five": 100,
"formattedVal": "1,000",
"four": 120,
"fourteen": 80,
"newUserCount": 1000,
"one": 500,
"seven": 200,
"six": 150,
"thirty": 50,
"three": 300,
"two": 400,
"val": 1000
}
]
}
# 19.9 Device Data - Get Mini-Program Device Distribution
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/device
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "iOS",
"proportion": "50%",
"value": 1000
}
]
}
# 19.10 Device Data - Get Mini-Program Screen Resolution Distribution
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/screen
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "1920x1080",
"proportion": "50%",
"value": 1000
}
]
}
# 19.11 Device Data - Get Mini-Program Phone Brand Distribution
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/brand
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "Huawei",
"proportion": "50%",
"value": 1000
}
]
}
# 19.12 Device Data - Get Mini-Program SDK Version Distribution
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/sdk-version
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "v3.0.0",
"proportion": "50%",
"value": 1000
}
]
}
# 19.13 Get Mini-Program Basic Pack Version Distribution
Request URL
GET /api/v1/open/dev/stat/basic/mini-app/basic-pack-version Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "v1.0.0",
"proportion": "50%",
"value": 1000
}
]
}
# 9.14 Data Dashboard - Regional Application Source Distribution
Request URL
GET /api/v1/open/dev/stat/basic/billboard/region
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| isRunPlay | boolean | No | query | Whether it is run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "East China",
"proportion": "50%",
"value": 1000
}
]
}
# Common Error Codes
The following defines a dictionary of common error codes used across interfaces for return value judgment and error troubleshooting.
| errcode Error Code | Description |
|---|---|
| OK | Success |
| ECODE_PARAM_ERR | Parameter error. The request parameters are invalid. Check the request parameters. |
| ECODE_UNAUTHORIZED | Unauthenticated. Unable to identify the user. Check if the current PersonalAccessToken is correct. |
| ECODE_FORBIDDEN | Unauthorized. The permissions corresponding to the current PersonalAccessToken are insufficient to access the current interface. |
| ECODE_SERVER_ERR | Internal server error. Unexpected error. Please provide the traceid from the response to the system administrator for feedback. |
| ECODE_LICENSE_NOT_SUPPORT_OPEN_API_ERROR | The current license does not support the open-api feature and cannot be used. |
| OPEN_API_ACCESS_TOKEN_NOT_FOUND_ERR | The current PersonalAccessToken does not exist. |
| ECODE_PERSONAL_ACCESS_TOKEN_CROSS_PLATFORM_ERROR | Using a PersonalAccessToken from the Developer Center or Digital Center to access an interface on the other platform. |
| ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE | Unable to identify the user. Check if the current PersonalAccessToken is correct. |
| ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE | The permissions corresponding to the current PersonalAccessToken are insufficient to access the current interface. |