开发 地图小程序OPENAPI 开发指南 地图内容 自定义图标

自定义图标 最后更新时间: 2024年08月30日

产品介绍

本文档 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/删除/查询自定义图标相关的能力。

适用场景

  • 图标样式-->设置图标-->『填充物』-->『自定义图标』

使用限制

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

使用说明

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

1、图标自定义填充物新增

请求地址

URL

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

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

string

iconFillerShowType

填充物类型

1-文本; 2-图片;

Integer

iconFillerValue

填充物的值

文本类型时为图标的文字(两个半角字符或一个中文汉字);

图片类型时为图片的url

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/map/icon/config/add";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    Map<String, Object> requestParams = new HashMap<>();
    requestParams.put("key", key);
    requestParams.put("openId", openId);
    requestParams.put("bizToken", bizToken);
    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("iconFillerShowType", 1);
    postParams.put("iconFillerValue", "门");
    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

data

示例如下:

{

"iconFillerId": "自定义填充物id"

}

附表

0、异常

1、成功

2、失败

3、参数错误

140001、权限不足:『不是地图管理员』

2、图标自定义填充物删除

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/icon/config/remove/batch

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

iconFillerIds

填充物id

多个id可以用逗号分隔,例如:"1,2,3"

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/map/icon/config/remove/batch";
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    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("iconFillerIds", "50042888743012,50042888743009");
    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、参数错误

140001、权限不足:『不是地图管理员』

3、图标自定义填充物分页查询

请求地址

URL

https://restwia.amap.com/api/v1/wia/core/icon/config/query

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

openId

高德开放用户id

操作人在高德的身份id

string

workMapId

地图id

-

string

pageNumber

页码

从1开始

Integer

pageSize

每页大小

最大50

Integer

iconFillerShowType

填充物类型

1-文本; 2-图片;

Integer

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/map/icon/config/query";
    BasicEnvConf env = getCurrentEnviroment();
    Map<String, Object> params = new HashMap<>();
    String key = "在高德开放平台申请的key";
    String openId = "当前操作用户的openId";
    String workMapId ="要操作的工作地图id";
    String bizToken = "在高德开放平台申请的bizToken";
    String bizSecret = "在高德开放平台申请的bizSecret";
    params.put("key", key);
    params.put("openId", openId);
    params.put("workMapId", workMapId);
    params.put("pageNumber", 1);
    params.put("pageSize", 5);
    params.put("iconFillerShowType", 1);
    params.put("bizToken", bizToken);
    String[] signArgs = new String[]{workMapId,openId};
    params.put("bizSign", SignatureHelper.calcSign(bizSecret, signArgs));
    url = MyHttpUtils.attachParamsToUrl(url, params);
    String response = MyHttpUtils.postFormUrlencoded(url, null);
    System.out.println(response);
    
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

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

version

版本号

字符串类型

timestamp

时间戳

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

requestId

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

字符串格式,长度30

data

示例如下:

{

  "iconFillerList": [

  {

      "iconFillerId": "自定义填充物id",

      "iconFillerShowType": 1, // 图标填充物类型:1-文本; 2-图片

      "iconFillerValue": "图标填充物的值,文本类型时为图标的文字,图片类型时为图片的url"

    }

  ]

}

附表

0、异常

1、成功

2、失败

3、参数错误

140001、权限不足:『不是地图成员』

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