明道云开放平台

正在加载页面

鉴权方式

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

版本

请求地址

POST

Header 参数

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

Body 参数

名称	类型	必填	描述
`responseFormat`	`string`	否	json：返回 JSON，md：返回 md 文本(更省 token)。默认为 json 示例值：`"json"` 可选值： `"json""md"`
`worksheets`	`string[]`	否	指定返回工作表 id，填入后返回数据中只包含这些工作表信息

响应参数

200成功获取工作表列表

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object[]`	—
`data.id`	`string`	工作表ID
`data.name`	`string`	工作表名称
`data.remark`	`string`	工作表备注

curl -X POST "https://example.com/v3/app/worksheets/list" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true,  "error_code": 0,  "error_msg": "string",  "data": [    {      "id": "string",      "name": "string",      "remark": "string"    }  ]}