开发 地图小程序OPENAPI 开发指南 地图内容 绘制面资源

绘制面资源 最后更新时间: 2024年08月30日

产品介绍

『绘制面』资源 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/修改/删除『绘制面』的能力。

适用场景

  • 创建面资源
  • 修改面资源
  • 删除面资源
  • 查询单个面资源详情

使用限制

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

使用说明

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

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

1、新增『绘制面』

请求地址

URL

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

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

是

无

openId

高德开放用户id

操作人在高德的身份id

string

是

无

workMapId

地图id

string

是

无

title

区域名称

string

是

无

desc

描述

string

否

无

color

颜色

枚举:

BLUE_1(1, "#7E97FF,#4265FF","蓝1"),

BLUE_2(2, "#7AB1F5,#307EDF","蓝2"),

BLUE_3(3, "#4CC7FF,#39A1F8","蓝3"),

CYCAN(4, "#12E3AA,#18AD78","青"),

YELLOW(5, "#FFBF00,#FD9A00","黄"),

ORANGE(6, "#FF983F,#F96328","橙"),

RED_1(7, "#EA7864,#D76049","红1"),

RED_2(8, "#FF6968,#F74746","红2");

Integer

是

无

imgList

照片

示例:[{"originalUrl": "http://xx.cn/xx.png"}]

string

否

无

firstPoint

区域面主点

面上第一个点的标准poi,区域面展示为一个点时的坐标位置。

示例:{"lat":40.03044215520612,"lon":116.4339244359213,"name":"poi点名称"}

string

是

无

polygonInfo

多边形点信息

经度和纬度之间空格分隔,多个点的经纬度之间半角逗号分隔,前缀和后缀见示例:POLYGON((116.43659837543292 40.017234979293875,116.43034100051642 40.019648795274236,116.44148112740363 40.02771819946398,116.43659837543292 40.017234979293875))

string

是

无

categoryId

文件夹id

string

否

无

principal

负责人openId

半角逗号分隔

string

否

无

dimensionId

自定义字段分组id

string

否

无

customFieldValueInfo

自定义字段集合

参考新建点资源接口的customFieldValueInfo入参

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 requestUrl = "https://restwia.amap.com/api/v1/wia/surface/create";
        //url param
        HashMap<String, Object> param = Maps.newHashMap();
        param.put("key", "在高德开放平台申请的key");
        param.put("openId", "当前操作用户的openId");
        param.put("bizToken", "在高德开放平台申请的bizToken");
        param.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"工作地图id","openId"}));

        param.put("workMapId",env.getWorkMapId());
        param.put("title","测试面资源");
        param.put("desc","desc");
        param.put("color",1);
//        param.put("imgList","[,]");
        HashMap<String, Object> firstPoint = Maps.newHashMap();
        firstPoint.put("name","名称");
        firstPoint.put("lat",40.03044215520612);
        firstPoint.put("lon",116.4339244359213);
        param.put("firstPoint", JSONObject.toJSONString(firstPoint));
        param.put("polygonInfo","POLYGON((116.43659837543292 40.017234979293875,116.43034100051642 40.019648795274236,116.44148112740363 40.02771819946398,116.43659837543292 40.017234979293875))");
//        param.put("categoryId","文件夹id");
        param.put("principal","负责人1openId,负责人2openId");//半角逗号分隔

        String s = MyHttpUtils.postFormUrlencoded(requestUrl, param);
}

返回参数

返回字段

含义

规则说明

data

数据体,示例如下:

{

"resourceId": "资源id"

}

code

返回结果编码

1 表示成功

message

返回状态说明

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

version

版本号

字符串类型

timestamp

时间戳

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

requestId

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

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

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

1003、工作地图不存在

1005、工作地图已删除

140002、资源数量已达上限

140005、无文件夹内容新增操作权限

2. 修改『绘制面』

请求地址

URL

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

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

是

无

openId

高德开放用户id

操作人在高德的身份id

string

是

无

workMapId

地图id

string

是

无

resourceId

资源id

string

是

无

title

区域名称

string

是

无

desc

描述

string

否

无

color

颜色

枚举:

BLUE_1(1, "#7E97FF,#4265FF","蓝1"),

BLUE_2(2, "#7AB1F5,#307EDF","蓝2"),

BLUE_3(3, "#4CC7FF,#39A1F8","蓝3"),

CYCAN(4, "#12E3AA,#18AD78","青"),

YELLOW(5, "#FFBF00,#FD9A00","黄"),

ORANGE(6, "#FF983F,#F96328","橙"),

RED_1(7, "#EA7864,#D76049","红1"),

RED_2(8, "#FF6968,#F74746","红2");

Integer

是

无

imgList

照片

示例:[{"originalUrl": "http://xx.cn/xx.png"}]

string

否

无

firstPoint

区域面主点

面上第一个点的标准poi,区域面展示为一个点时的坐标位置。

示例:{"lat":40.03044215520612,"lon":116.4339244359213,"name":"poi点名称"}

string

是

无

polygonInfo

多边形点信息

经度和纬度之间空格分隔,多个点的经纬度之间半角逗号分隔,前缀和后缀见示例:POLYGON((116.43659837543292 40.017234979293875,116.43034100051642 40.019648795274236,116.44148112740363 40.02771819946398,116.43659837543292 40.017234979293875))

string

是

无

categoryId

文件夹id

string

否

无

principal

负责人openId

半角逗号分隔

string

否

无

dimensionId

自定义字段分组id

string

否

无

customFieldValueInfo

自定义字段集合

参考新建点资源接口的customFieldValueInfo入参

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 requestUrl = "https://restwia.amap.com/api/v1/wia/surface/update";
      
        //url param
        HashMap<String, Object> param = Maps.newHashMap();
        param.put("key", "在高德开放平台申请的key");
        param.put("openId", "当前操作用户的openId");
        param.put("bizToken", "在高德开放平台申请的bizToken");
        param.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"工作地图id","openId"}));

        param.put("workMapId",env.getWorkMapId());
        param.put("resourceId","面资源resourceid");
        param.put("title","测试面资源");
        param.put("desc","desc");
        param.put("color",1);
//        param.put("imgList","[,]");
        HashMap<String, Object> firstPoint = Maps.newHashMap();
        firstPoint.put("name","名称");
        firstPoint.put("lat",40.03044215520612);
        firstPoint.put("lon",116.4339244359213);
        param.put("firstPoint", JSONObject.toJSONString(firstPoint));
        param.put("polygonInfo","POLYGON((116.43659837543292 40.017234979293875,116.43034100051642 40.019648795274236,116.44148112740363 40.02771819946398,116.43659837543292 40.017234979293875))");
//        param.put("categoryId","文件夹id");
        param.put("principal","负责人1openId,负责人2openId");//半角逗号分隔

        String s = MyHttpUtils.postFormUrlencoded(requestUrl, param);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

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

version

版本号

字符串类型

timestamp

时间戳

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

requestId

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

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

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

1003、工作地图不存在

1005、工作地图已删除

120003、资源id不存在

140006、无文件夹内容编辑操作权限

3. 删除『绘制面』

请求地址

URL

https://restwia.amap.com/api/v1/wia/surface/remove

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

是

无

openId

高德开放用户id

操作人在高德的身份id

string

是

无

workMapId

地图id

string

是

无

resourceId

资源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 requestUrl = "https://restwia.amap.com/api/v1/wia/surface/remove";
        //url param
        HashMap<String, Object> param = Maps.newHashMap();
        param.put("key", "在高德开放平台申请的key");
        param.put("openId", "当前操作用户的openId");
        param.put("bizToken", "在高德开放平台申请的bizToken");
        param.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"工作地图id","openId"}));

          param.put("workMapId","工作地图id");
        param.put("resourceId","面资源资源点id");

        String s = MyHttpUtils.postFormUrlencoded(requestUrl, param);
}

返回参数

返回字段

含义

规则说明

code

返回结果编码

1 表示成功

message

返回状态说明

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

version

版本号

字符串类型

timestamp

时间戳

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

requestId

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

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

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

1003、工作地图不存在

1005、工作地图已删除

120003、资源id不存在

140007、无文件夹内容删除操作权限

4. 查询单个『绘制面』详情

请求地址

URL

https://restwia.amap.com/api/v1/wia/surface/detail

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

请求参数

参数名

含义

规则说明

参数类型

是否必填

缺省值

key

请求服务权限标识 

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

string

是

无

openId

高德开放用户id

操作人在高德的身份id

string

是

无

workMapId

地图id

string

是

无

resourceId

资源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 requestUrl = "https://restwia.amap.com/api/v1/wia/surface/detail";
        //url param
        HashMap<String, Object> param = Maps.newHashMap();
        param.put("key", "在高德开放平台申请的key");
        param.put("openId", "当前操作用户的openId");
        param.put("bizToken", "在高德开放平台申请的bizToken");
        param.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",new String[]{"工作地图id","openId"}));

          param.put("workMapId","工作地图id");
        param.put("resourceId","面资源资源点id");

        String s = MyHttpUtils.postFormUrlencoded(requestUrl, param);
}

返回参数

返回字段

含义

规则说明

data

数据体,示例如下(字段含义可以参考新增『绘制面』接口入参):

{

  "title": "surface1",

  "desc": "surface_desc1",

  "color": 4,

  "imgList": "[{\"originalUrl\":\"https://a.amap.com/lbs/static/img/doc/doc_1693821389170_d2b5c.png\"}]",

  "firstPoint": "{\"lat\":40.017234979293875,\"lon\":116.43659837543292,\"name\":\"surface_point_name1\",\"address\":\"surface_point_address1\"}",

  "polygonInfo": "POLYGON((116.43659837543292 40.017234979293875,116.43034100051642 40.019648795274236,116.44148112740363 40.02771819946398,116.43659837543292 40.017234979293875))",

  "categoryId": "400376903557002",

  "principal": [

    {

      "openId": "_wdqmShBmSH2T7z1BIqORgAPHMXbcv8e9q9cNKQofM-ndJTHzKsCuHc4pOyjTN1n", // 负责人openId

      "nickName": "王迟众", // 负责人昵称

      "iconImage": "http://xx/x.png" // 负责人头像

    }

  ],

  "dimensionId": "528001010000584003",

  "customFieldValueInfo": [

    {

      "itemId": "428001010001556008",

      "viewText": "文本1",

      "itemType": 1,

      "valueList": [

        {

          "value": "值111"

        }

      ]

    }

  ],

  "createUserId": "_wdqmShBmSH2T7z1BIqORgAPHMXbcv8e9q9cNKQofM-ndJTHzKsCuHc4pOyjTN1n", // 创建人openId

  "createUserName": "王迟众", // 创建人昵称

  "createTime": 1694508906155, // 创建时间

  "updateUserId": "_wdqmShBmSH2T7z1BIqORgAPHMXbcv8e9q9cNKQofM-ndJTHzKsCuHc4pOyjTN1n", // 最后修改人openId

  "updateUserName": "王迟众", // 最后修改人昵称

  "updateTime": 1694523960209 // 最后修改时间

}

code

返回结果编码

1 表示成功

message

返回状态说明

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

version

版本号

字符串类型

timestamp

时间戳

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

requestId

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

字符串格式,长度30

附表

0、异常

1、成功

2、失败

3、参数错误

1001、没有权限(不是地图成员、没有此资源的查看权限)

1003、工作地图不存在

1005、工作地图已删除

5. 分页查询『绘制面』资源列表

参考/api/v1/wia/resource/list接口。

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