明道云开放平台

正在加载页面

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

GET

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

响应参数

200成功获取应用信息

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	应用详细信息
`data.organizationId`	`string`	组织 id
`data.appId`	`string`	应用ID
`data.name`	`string`	应用名称
`data.iconUrl`	`string`	图标地址
`data.color`	`string`	颜色
`data.desc`	`string`	应用说明
`data.remark`	`string`	应用描述
`data.sections`	`object[]`	分组信息
`data.sections.id`	`string`	应用分组id
`data.sections.name`	`string`	分组名称
`data.sections.items`	`object[]`	分组下应用项信息
`data.sections.items.id`	`string`	应用项id
`data.sections.items.name`	`string`	应用项名称
`data.sections.items.type`	`integer`	应用项类型，0:工作表、1:自定义页面、2：子分组
`data.sections.items.typeName`	`string`	应用项类型名称可选值： `"chatbot""worksheet""customPage""section"`
`data.sections.items.remark`	`string`	对话机器人或自定义页面的备注说明
`data.sections.items.iconUrl`	`string`	应用项图标地址
`data.sections.items.status`	`integer`	状态
`data.sections.items.alias`	`string`	别名
`data.sections.items.notes`	`string`	开发者备注
`data.sections.childSections`	`object,null[]`	子分组信息
`data.sections.childSections.id`	`string`	子分组id
`data.sections.childSections.name`	`string`	子分组名称
`data.sections.childSections.items`	`object[]`	—
`data.sections.childSections.items.id`	`string`	应用项id
`data.sections.childSections.items.name`	`string`	应用项名称
`data.sections.childSections.items.type`	`integer`	应用项类型，0:工作表、1:自定义页面、2：子分组
`data.sections.childSections.items.typeName`	`string`	应用项类型名称可选值： `"chatbot""worksheet""customPage""section"`
`data.sections.childSections.items.remark`	`string`	对话机器人或自定义页面的备注说明
`data.sections.childSections.items.iconUrl`	`string`	应用项图标地址
`data.sections.childSections.items.status`	`integer`	状态
`data.sections.childSections.items.alias`	`string`	别名
`data.sections.childSections.items.notes`	`string`	开发者备注

curl -X GET "https://example.com/v3/app" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}"

{  "success": true,  "error_code": 1,  "error_msg": "",  "data": {    "organizationId": "string",    "appId": "string",    "name": "string",    "iconUrl": "string",    "color": "string",    "desc": "string",    "remark": "string",    "sections": [      {        "id": "string",        "name": "string",        "items": [          {            "id": "string",            "name": "string",            "type": 0,            "typeName": "worksheet",            "iconUrl": "string",            "status": 0,            "alias": "string",            "notes": "string"          }        ],        "childSections": [          {            "id": "string",            "name": "string",            "items": [              {                "id": "string",                "name": "string",                "type": 1,                "typeName": "customPage",                "remark": "string",                "iconUrl": "string",                "status": 0,                "alias": "string",                "notes": "string"              }            ]          }        ]      }    ]  }}

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

应用详细信息

data.organizationId

string

组织 id

data.appId

string

应用ID

data.name

string

应用名称

data.iconUrl

string

图标地址

data.color

string

颜色

data.desc

string

应用说明

data.remark

string

应用描述

data.sections

object[]

分组信息

data.sections.id

string

应用分组id

data.sections.name

string

分组名称

data.sections.items

object[]

分组下应用项信息

data.sections.items.id

string

应用项id

data.sections.items.name

string

应用项名称

data.sections.items.type

integer

应用项类型，0:工作表、1:自定义页面、2：子分组

data.sections.items.typeName

string

应用项类型名称

可选值：

"chatbot""worksheet""customPage""section"

data.sections.items.remark

string

对话机器人或自定义页面的备注说明

data.sections.items.iconUrl

string

应用项图标地址

data.sections.items.status

integer

状态

data.sections.items.alias

string

别名

data.sections.items.notes

string

开发者备注

data.sections.childSections

object,null[]

子分组信息

data.sections.childSections.id

string

子分组id

data.sections.childSections.name

string

子分组名称

data.sections.childSections.items

object[]

—

data.sections.childSections.items.id

string

应用项id

data.sections.childSections.items.name

string

应用项名称

data.sections.childSections.items.type

integer

应用项类型，0:工作表、1:自定义页面、2：子分组

data.sections.childSections.items.typeName

string

应用项类型名称

可选值：

"chatbot""worksheet""customPage""section"

data.sections.childSections.items.remark

string

对话机器人或自定义页面的备注说明

data.sections.childSections.items.iconUrl

string

应用项图标地址

data.sections.childSections.items.status

integer

状态

data.sections.childSections.items.alias

string

别名

data.sections.childSections.items.notes

string

开发者备注

{ "success": true, "error_code": 1, "error_msg": "", "data": { "organizationId": "string", "appId": "string", "name": "string", "iconUrl": "string", "color": "string", "desc": "string", "remark": "string", "sections": [ { "id": "string", "name": "string", "items": [ { "id": "string", "name": "string", "type": 0, "typeName": "worksheet", "iconUrl": "string", "status": 0, "alias": "string", "notes": "string" } ], "childSections": [ { "id": "string", "name": "string", "items": [ { "id": "string", "name": "string", "type": 1, "typeName": "customPage", "remark": "string", "iconUrl": "string", "status": 0, "alias": "string", "notes": "string" } ] } ] } ] }}