开发 地图小程序OPENAPI 开发指南 工作地图 地图生产

地图 最后更新时间: 2023年09月04日

产品介绍

该 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/修改/删除地图、添加/移除地图成员的能力。

使用限制

详细的服务调用量限制可点我查阅

使用说明

接收请求返回的数据(JSON或XML格式),参考返回参数文档解析数据。

如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

1. 新建地图

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/create

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

用户在高德的身份id

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

workMapName

地图名称

地图名称长度最大不能超过40位,不能存在违反相关法律法规的敏感词汇

string

按系统默认的生成规则生成

bizSign

业务签名

签名参数:openId, bizToken (参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/create";
    String openId = "当前操作用户的openId";
    String key = "在高德开放平台申请的key";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String workMapName = "测试地图" + TimeUtil.getTimeString("yy-MM-dd HH-mm");
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("openId", openId);
    requestParams.put("bizToken", bizToken);
    String[] signArgs = new String[]{openId,bizToken};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("workMapName", workMapName);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段

含义

参数类型

规则说明

data

数据体

object

workMapId

地图id

sring

字符串类型

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

成功时返回Successful,否则返回错误原因

version

版本号

string

字符串类型

timestamp

时间戳

number

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

120002、用户下地图数量已达上限

120004地图名称违规

120007、地图名称长度不符合要求

2. 获取地图信息

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/info

请求方式

GET

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

用户在高德的身份id

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

workMapId

地图id

-

string

bizSign

业务签名

签名参数:workMapId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/info";
    Map<String, Object> params = new HashMap<>();
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String workMapId ="要操作的工作地图id";
    params.put("key", key);
    params.put("openId", openId);
    params.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId};
    params.put("workMapId", workMapId);
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.get(url);
    System.out.println(response);
}

返回参数

返回字段

含义

参数类型

规则说明

data

示例

数据体

object

{

    "shareCode": "462029925",

    "workMapId": "suaVpq2KfI0Aijenupoh2A",

    "workMapName": "地图2023111",

    "superManagerInfo": {

    "openId": "Cf2PHEveye_pHdqjMCXjANpj7jQ4OBN585KzlV3FycandJTHzKsCuHc4pOyjTN1n",

    "nickName": "地图名称",

    "iconImage": "http://img-cdn-test.amap.com/g/avatar/13.png?ver=1686661244&imgoss=1"

    }

地图id

sring

字符串类型

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

成功时返回Successful,否则返回错误原因

version

版本号

string

字符串类型

timestamp

时间戳

number

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

120002、用户下地图数量已达上限

120004地图名称违规

120007、地图名称长度不符合要求

3.获取地图列表

如无特殊声明,接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/list

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户ID

用户在高德的身份ID

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

pageSize

 每一页的返回个数

 范围是 10 - 100,正整数

number

20

pageNumber

当前页码

范围是 1 - 100,正整数

number

1

bizSign

业务签名

签名参数:openId, bizToken详见签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/list";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    Map<String, Object> params = new HashMap<>();
    params.put("key", key);
    params.put("openId", openId);
    params.put("bizToken", bizToken);
    params.put("pageNumber", 1);
    params.put("pageSize", 50);
    String[] signArgs = new String[]{openId, bizToken};
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.postFormUrlencoded(url, null);
    System.out.println(response);
}

返回参数

返回字段

含义

参数类型

规则说明

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

成功时返回Successful,否则返回错误原因

version

版本号

string

字符串类型

timestamp

时间戳

number

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

string

字符串格式,长度30

data

object

hasMore

1 表示还有下一页,0表示本页为最后页

boolean

nextPageNumber

下一页页码,下次请求的时候用。默认为本次请求入参的 pageNumber +1

number

dataList

 [{
			"shareCode": "6013141235142",/* 地图码 */
			"workMapId": "E5qI6wEXaczgErkx4-RQ", /*工作地图id*/
			"workMapName": "test team",/* 工作地图名称 */
			"superManagerInfo": {/*超管信息*/
				"openId": "CfPHEveye_pHdqjMCXjNpj7jQ4OBN585KzlFycandJTzKsCuHc4pOyjTN1n9",
				"nickName": "amap_WvAVtQ3DrT",
				"iconImage": "http://img-cdn-test.amap.com/g/avatar/13.png?ver=1686661244&imgoss=1"
			}
		}, {
			"shareCode": "4620889899225",
			"workMapId": "suaVp2KfAijenuph2As4gbs",
			"teamName": "环卫巡检打点",
			"superManagerInfo": {
				"openId": "CfPHEveye_pHdqjMCXjNpj7jQ4OBN585KzlFycandJTzKsCuHc4pOyjTN1n9",
				"nickName": "amap_WvAVtQ3DrT",
				"iconImage": "http://img-cdn-test.amap.com/g/avatar/13.png?ver=1686661244&imgoss=1"
			}
		}]

array

此处协议要改一改

4. 修改地图信息

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/update

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户ID

用户在高德的身份ID

string

workMapId

地图id

创建地图后返回的地图ID

string

workMapName

地图名称

地图名称长度最大不能超过40位,不能存在违反相关法律法规的敏感词汇

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId (参考签名规则

string

返回参数

返回字段

含义

参数类型

规则说明

data

数据体

object

无数据

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

成功时返回Successful,否则返回错误原因

version

版本号

string

字符串类型

timestamp

时间戳

number

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110004、用户无权限

120003、地图不存在

120004地图名称违规

120007、地图名称长度不符合要求

5. 删除地图

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/delete

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

特别注意:暂无。

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户ID

用户在高德的身份ID

string

workMapId

地图id

创建地图后返回的地图ID

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId (参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/delete";
    String openId = "当前操作用户的openId";
    String key = "在高德开放平台申请的key";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String workMapId ="要操作的工作地图id";
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("openId", openId);
    requestParams.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("workMapId", workMapId);
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段

含义

参数类型

规则说明

data

数据体

object

无数据

code

返回结果编码

number

1 表示成功

message

返回状态说明

string

成功时返回Successful,否则返回错误原因

version

版本号

string

字符串类型

timestamp

时间戳

number

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

string

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

110004、用户无权限

120003、地图不存在

6. 地图超管转移

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/transfer

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

targetOpenId

新超管openId

新超管用户在高德的身份id

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId, openId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/transfer";
    String openId = "当前超级管理员的openId";
    String key = "在高德开放平台申请的key";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String workMapId ="要操作的工作地图id";
    String targetOpenId = "新的超级管理员 openId";
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("bizToken", bizToken);
    requestParams.put("openId", openId);
    
    String[] signArgs = new String[]{workMapId, openId};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("workMapId", workMapId);
    postParams.put("targetOpenId", targetOpenId);
    
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1003、工作地图不存在

1005、工作地图已删除

1001、没有权限(操作人不是超管、指定的新超管不是地图成员)

120008、机构认证过的地图不能转移超管

7. 新增地图管理员

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/manager/add

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

openIds

新管理员openId

用户在高德的身份id,半角逗号分隔

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId, openId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/manager/add";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String openIds = "见参数说明";
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("bizToken", bizToken);
    requestParams.put("openId", openId);
    String[] signArgs = new String[]{workMapId,openId};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("workMapId", workMapId);
    postParams.put("openIds", openIds);
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1003、工作地图不存在

1005、工作地图已删除

1001、没有权限(操作人不是超管、指定的新管理员不是地图成员)

2009、指定的新管理员不是普通成员

2010、管理员数量超限

8. 移除地图管理员

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/manager/remove

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

openIds

要删除的管理员openId

用户在高德的身份id,半角逗号分隔

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId, openId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/manager/remove";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String openIds = "见参数说明";
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("bizToken", bizToken);
    requestParams.put("openId", openId);
    String[] signArgs = new String[]{workMapId,openId};
    requestParams.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    Map<String, Object> postParams = new HashMap<>();
    postParams.put("workMapId", workMapId);
    postParams.put("openIds", openIds);
    url = MyHttpUtils.attachParamsToUrl(url, requestParams);
    String response = MyHttpUtils.postFormUrlencoded(url, postParams);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1003、工作地图不存在

1005、工作地图已删除

1001、没有权限(操作人不是超管、openIds指定的用户不是地图成员)

2009、openIds指定的用户不是地图管理员

9、生成二维码链接

此接口用于生成二维码,邀请其他用户加入地图(其他用户需要用高德地图扫码加入)。

此接口返回的字段中,有『二维码链接』,使用方需要根据这个链接自己生成二维码图片。

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/qrCode

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

用户在高德地图官网申请Web服务API类型KEY 

string

openId

高德开放用户id

用户在高德的身份id

string

workMapId

地图id

-

string

bizToken

工作地图身份token

用户申请的工作地图身份token,一个组织一个token

string

bizSign

业务签名

签名参数:workMapId, openId(参考签名规则

string

示例代码(以java为例)

import com.amap.wia.openapi.test.lib.MyHttpUtils;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/demo-lib
import com.amap.wia.openapi.test.lib.SignatureHelper;//见 https://lbs.amap.com/api/wia-openapi/guide/tools/biz-token-sign
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {
    String url = "https://restwia.amap.com/api/v1/wia/core/qrCode";
    Map<String, Object> params = new HashMap<>();
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    String workMapId ="要操作的工作地图id";
    params.put("key", key);
    params.put("openId", openId);
    params.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId, openId};
    params.put("workMapId", workMapId);
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.postFormUrlencoded(url, null);
    System.out.println(response);
}

返回参数

返回字段

含义

规则说明

data

数据体,示例如下:

{

  "mapName": "工作地图名称",

  "mapIcon": "工作地图图标链接",

  "orgName": "组织名称",

  "nickName": "邀请人的昵称",

  "binaryCodeLink": "二维码链接",

  "binaryCodeDays": 14, // 二维码链接有效期 单位为『天』   "binaryCodeExpireMillis": 1692104398453 // 二维码过期时间戳 单位为毫秒

}

code

返回结果编码

1 表示成功

message

返回状态说明

成功时返回Successful,否则返回错误原因

version

版本号

字符串类型

timestamp

时间戳

Unix 时间戳,参考文档:《Unix 时间戳》

requestId

requestId是RPC链路的全局唯一标识,排查问题时需要提供

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1003、工作地图不存在

1005、工作地图已删除

1001、没有权限(不是地图成员)

返回顶部 示例中心 常见问题 智能客服 公众号
二维码