产品介绍
在地图中,文件夹用于对标记资源进行分类管理。文件夹 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/修改/批量删除文件夹、在文件夹间转移标记资源的能力。
适用场景
新建文件夹:创建一个空的文件夹;创建文件夹时如果携带资源id,可以创建文件夹的同时,将资源放入
修改文件夹:修改文件夹名称
批量删除文件夹:删除文件夹,同时删除文件夹下所有资源
资源转移:将资源从文件夹A移出;将资源移入文件夹B;将资源从文件夹A移动到文件夹B
使用限制
详细的服务调用量限制可点我查阅。
使用说明
接收请求返回的数据(JSON或XML格式),参考返回参数文档解析数据。
如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
1. 新建文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
title | 文件夹名称 |
| string | 必填 | 无 |
parentCategoryId | 父文件夹 id | 说明: 创建子文件夹,父文件夹必填 | string | 非必填 | 无 |
parentCategoryLevel | 父文件夹层级 | 校验层级目前支持 5 层文件夹 值:0,1,2,3,4 | int | 非必填 |
|
sig | 数字签名 | 请参考数字签名获取和使用方法 | string | 可选 | 无 |
bizSign | 业务签名 | 签名参数:workMapId (参考签名规则) | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 结果对象,包括下述字段: |
| categoryId | 文件夹id | string |
|
| workMapId | 地图id | string | 和入参中的workMapId参数一致 |
2. 修改文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
title | 文件夹名称 |
| string | 必填 | 无 |
categoryId | 待修改文件夹id |
| string | 必填 | 无 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | string | 可选 | 无 |
bizSign | 业务签名 | 签名参数:workMapId , categoryId (参考签名规则) | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 为true表示修改成功 |
3. 批量删除文件夹
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
categoryIds | 要删除的文件夹列表 | 多个时使用,分割。示例:categoryId1,categoryId2 | array | 必填 | 无 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | string | 可选 | 无 |
bizSign | 业务签名 | 签名参数:workMapId , categoryIds (参考签名规则) | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 为true表示修改成功 |
4. 资源转移
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
resourceIds | 要转移的资源列表 | 多个时使用,分割。示例:resourceId1,resourceId2 资源数量阀值:100 | string | 必填 | 无 |
targetCategoryId | 目标文件夹id | 说明: 1、不填,默认查询所有的一级文件 2、填写,查询当前文件夹下的所有文件夹id | string | 可选 | 无 |
sig | 数字签名 | 请参考数字签名获取和使用方法 | string | 可选 | 无 |
bizSign | 业务签名 | 签名参数:workMapId , resourceIds (参考签名规则) | string | 必填 | 无 |
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 为true表示修改成功 |
5. 查询地图内的文件夹列表
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
bizSign | 业务签名 | 签名参数:workMapId(参考签名规则) | string | 必填 | 无 |
pageSize | 每页返回的数量 | 100及以内的正整数 | int | 必填 | 50 |
pageNumber | 页码 | 首次请求为 1 | int | 非必填 | 无 |
sortType | 排序类型 | 0-按更新时间 1-按距离排序 2-按名称A-Z 3-按名称Z-A | int | 必填 | 无 |
parentCategoryId | 父级文件夹id |
| string | 非必填 | 无 |
代码实例(以java为例)
import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
* 通用 import 内容等暂略
*/
public static void main(String[] args) {
String url = "http://restwia.amap.com/api/v1/wia/category/list";
Map<String, Object> params = new HashMap<>();
String openId = "当前操作用户的openId";
String workMapId = "工作地图id";
params.put("key","在高德开放平台申请的key");
params.put("openId",openId);
params.put("bizToken","在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
params.put("pageSize", 20);
params.put("pageNumber",1);
String[] signArgs = new String[]{workMapId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
url = MyHttpUtils.attachParamsToUrl(url, params);
String response = MyHttpUtils.get(url);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 为true表示修改成功 |
| categoryList | 文件夹列表 | List<Category> | 见 : Category |
Category
| categoryId | 文件夹id | string |
|
categoryTitle | 文件夹名称 | string |
|
categoryDesc | 文件夹描述 | string |
|
createUserOpenId | 创建人id | string |
|
createUserName | 创建人名称 | string |
|
createUserIcon | 创建人头像 | string |
|
pointCount | 资源点数量 | int |
|
gmtCreate | 创建时间 | date |
|
gmtModified | 修改时间 | date |
|
status | 线上状态 | int | 0-无效 1-有效 |
| hasMore | 是否有更多 | int | 0-没有 1-有 |
| count | 查询文件夹数量 | int |
|
6. 批量查询文件夹信息
请求地址
parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。
请求参数
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
key | 高德Key | 用户在高德地图官网申请Web服务API类型Key | string | 必填 | 无 |
workMapId | 高德工作地图id |
| string | 必填 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token,一个企业一个token | string | 必填 | 无 |
openId | 操作人 | 高德用户的开放id | string | 必填 | 无 |
bizSign | 业务签名 | 签名参数:workMapId(参考签名规则) | string | 必填 | 无 |
pageSize | 每页返回的数量 | 100及以内的正整数 | int | 必填 | 50 |
pageNumber | 页码 | 首次请求为 1 | int | 非必填 | 无 |
请求body
参数名 | 含义 | 规则说明 | 参数类型 | 是否必须 | 缺省值 |
categoryIds | 文件夹id 列表 | 示例: {"categoryIds": ["40042875302","400888713001","400428750400"]} | json array | 必填 | 无 |
代码实例(以java为例)
import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 http://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
* 通用 import 内容等暂略
*/
public static void main(String[] args) {
String url = "http://restwia.amap.com/api/v1/wia/category/batchQuery";
Map<String, Object> params = new HashMap<>();
String openId = "当前操作用户的openId";
String workMapId = "工作地图id";
params.put("key","在高德开放平台申请的key");
params.put("openId",openId);
params.put("bizToken","在高德开放平台申请的bizToken");
params.put("workMapId", workMapId);
String[] signArgs = new String[]{workMapId};
params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
url = MyHttpUtils.attachParamsToUrl(url, params);
String json = "{\"categoryIds\": [\"40042875302\",\"400888713001\",\"400428750400\"]}";
String response = MyHttpUtils.postApplicationJson(url,json);
System.out.println(response);
}
返回参数
响应结果的格式为 JSON 形式。
以下是返回参数说明:
名称 | 含义 | 参数类型 | 规则说明 |
code | 返回结果状态值 | number | 返回值为 0 或 1,0 表示请求失败;1 表示请求成功。 |
message | 返回状态说明 | string | 当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表 |
timestamp | 服务时间戳 | number |
|
data | 返回结果数据 | object | 为true表示修改成功 |
| categoryList | 文件夹列表 | List<Category> | 见 : Category |
Category
| categoryId | 文件夹id | string |
|
categoryTitle | 文件夹名称 | string |
|
categoryDesc | 文件夹描述 | string |
|
createUserOpenId | 创建人id | string |
|
createUserName | 创建人名称 | string |
|
createUserIcon | 创建人头像 | string |
|
pointCount | 资源点数量 | int |
|
gmtCreate | 创建时间 | date |
|
gmtModified | 修改时间 | date |
|
status | 线上状态 | int | 0-无效 1-有效 |
| hasMore | 是否有更多 | int | 0-没有 1-有 |
| count | 查询文件夹数量 | int |
|