明道云开放平台

正在加载页面

鉴权方式

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

版本

请求地址

GET

Header 参数

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

Query 参数

名称	类型	必填	描述
`id`	`string`	否	地区ID，不传则返回顶级地区列表
`search`	`string`	否	模糊搜索内容，搜索地区名称

响应参数

200成功获取地区信息

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	地区列表查询结果
`data.regions`	`object[]`	地区列表
`data.regions.id`	`string`	地区ID
`data.regions.name`	`string`	省、市、区/县名称
`data.regions.path`	`string`	地区路径
`data.regions.last`	`boolean`	是否还有下级地区

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

{  "data": {    "regions": [      {        "id": "110000",        "name": "北京市",        "path": "北京市",        "last": false      },      {        "id": "120000",        "name": "天津市",        "path": "天津市",        "last": false      },      {        "id": "130000",        "name": "河北省",        "path": "河北省",        "last": false      }    ]  },  "success": true}