开发 地图小程序OPENAPI 开发指南 地图内容 地点资源

地点资源 最后更新时间: 2024年02月28日

产品介绍

地点资源 API 是通过 HTTPS 协议访问远程服务的接口,提供新建/修改/删除标记地点的能力。

适用场景

  • 新建地点:创建地点资源
  • 修改地点:修改地点资源
  • 删除地点:删除地点资源
  • 查询地点:查询已创建的地点资源

使用限制

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

使用说明

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

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

1. 新建地点

请求地址

URL

https://restwia.amap.com/api/v1/wia/point/create?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数类型

是否必须

缺省值

key

高德Key

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

string

必填

workMapId

高德工作地图id

workMapId 通过地图查询活创建地图获得

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

可选

bizSign

业务签名

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

string

必填

http body 请求参数

参数名

含义

规则说明

是否必须

缺省值

title

地点名称

string

必填

desc

描述

string

可选

imgListStr

图片集合

示例:"[{\"originalUrl\": \"http...\"}]"

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");

string

可选

pointInfoStr

标准poi信息

可以从高德地理位置编码接口获取

注意:这里的lon/lat必须符合高德地图使用的坐标系及书写格式

{"new_type":"","address":"景山前街4号故宫博物院内","adcode":"","cityCode":"110000","lon":116.395999,"phoneNumbers":"","parentID":"","transparent":"","name":"历代艺术馆","x":221008875,"y":101704042,"poiid":"B000A9PIHK","end_poi_extension":"2","lat":39.917796,"driveLinkId":"10018608680002672001"}

string

必填( 其中driveLinkId选填)

categoryId

文件夹id

string

可选

iconFillerShowType

图标填充物类型

枚举:

1、自定义图标-填充文字(1个汉字或2个数字或字母);

2、自定义图标-填充图片;

3、预定义模板。

Integer

可选

iconFillerId

图标填充物id

『填充物类型』为1、2的时候,传『自定义图标填充物新增』接口返回的iconFillerId字段值;为3的时候传预定义的值(见下方图片上的红色数字)。

string

可选

iconOutline

图标外轮廓

外轮廓枚举值见下方图中的数字。

『填充物类型』为2时不支持设置外轮廓。

string

可选

dimensionId

自定义字段功能Id(自定义字段分组id)

200000010000000001

string

可选

customFieldValueInfo

自定义字段集合

组合使用示例:

[{"itemId":"422206010000638001","itemType":3,"viewText":"多选测试","valueList":[{"id":"176720341784090","value":"11","remarkValue":""},{"id":"176720341866005","value":"22","remarkValue":""}]},{"itemId":"422206010000656007","itemType":1,"viewText":"文本测试预付费","valueList":[{"value":"挺有意义"}]},{"itemId":"422206010000652006","itemType":2,"viewText":"单选测试嘿嘿","valueList":[{"id":1672021515326,"value":"解决","remarkValue":""}]},{"itemId":"422206010000656008","itemType":4,"viewText":"时间太晚","valueList":[{"value":1672021560000}]}]

不同类型的说明:

单选类型:

参考自定义字段分页拉取接口,选择对应的单选字段

{

  "itemId":"422206010000652006",

  "itemType":2,

  "viewText":"单选测试嘿嘿", 

  "valueList":[{

      "id":1672021515326,

      "value":"解决",  --选择的单选值

      "remarkValue":""

  }]

}

多选类型:

    {

        "itemId":"422206010000638001",

        "itemType":3,

        "viewText":"多选测试",

        "valueList":[

            {

                "id":"176720341784090",

                "value":"11",  ---多选1

                "remarkValue":""

            },

            {

                "id":"176720341866005",

                "value":"22",  ---多选2

                "remarkValue":""

            }

        ]

    }

文本类型:

    {

        "itemId":"422206010000656007",

        "itemType":1,

        "viewText":"文本测试预付费",

        "valueList":[

            {

                "value":"挺有意义"     ---输入文本的内容

            }

        ]

    }

时间类型:

    {

        "itemId":"422206010000656008",

        "itemType":4,

        "viewText":"时间太晚",

        "valueList":[

            {

                "value":1672021560000  ---选择的时间戳

            }

        ]

    }

数字类型:

{

  "itemId": "420020010001494004",

  "itemType": 5,

  "viewText": "数字字段11",

  "valueList": [

    {

      "value": "1234.56"

    }

  ]

}

日期类型:

{

  "itemId": "420020010001494003",

  "itemType": 6,

  "viewText": "日期字段11",

  "valueList": [

    {

      "value": 1692892800000 // 时间戳毫秒

    }

  ]

}

链接类型:

{

  "itemId": "420020010001494002",

  "itemType": 7,

  "viewText": "链接字段11",

  "valueList": [

    {

      "value": "http://abc.com  http开头"

    }

  ]

}

电话类型:

{

  "itemId": "420020010001490016",

  "itemType": 8,

  "viewText": "电话字段11",

  "valueList": [

    {

      "value": {

        "phoneType": "mobile",

        "text": "手机",

        "value": "11位手机号"

      }

    },

    {

      "value": {

        "phoneType": "phone",

        "text": "座机",

        "value": "01055555559 区号和电话"

      }

    }

  ]

}

链接类型:

{

  "itemId": "420020010001494001",

  "itemType": 9,

  "viewText": "图片字段1",

  "valueList": [ // 每张图片一个元素,每个元素里就一个value字段,格式如下。

    {

      "value": {

        "originalUrl": "https://track-second-bucket-test.oss-cn-shenzhen.aliyuncs.com/a3a34d061d1bad3c68c2a7d12285f0a9/084193d86fb611aed29597151ccf3f6d.jpg"

      }

    }

  ]

}

评星字段:

{

  "itemId": "420020010001490015",

  "itemType": 10,

  "viewText": "评星字段1",

  "valueList": [

    {

      "value": "1~5的数字"

    }

  ]

}

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 com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

  String url = "https://restwia.amap.com/api/v1/wia/point/create";
  Map<String, Object> params = new HashMap<>();
  String workMapId = "要操作的workMapId";
  params.put("key","在高德开放平台申请的key");
  params.put("workMapId",workMapId);
  params.put("openId","当前操作用户的openId");
  params.put("bizToken","在高德开放平台申请的bizToken");
  String[] signArgs = new String[]{workMapId};
  params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
  url = MyHttpUtils.attachParamsToUrl(url, params);

  Map<String, String> createMapRequest = Maps.newHashMap();
  createMapRequest.put("title","坐标点名称");
  createMapRequest.put("desc","坐标点描述信息11");
  PointInfoRequest obj = PointInfoRequest.builder().lat("39.917796").lon("116.395999").build();
  String pointInfoStr = JSONObject.toJSONString(obj);
  createMapRequest.put("pointInfoStr",pointInfoStr);
  
  String response = MyHttpUtils.postFormUrlencoded(url, createMapRequest);
  System.out.println(response);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

结果对象,包括下述字段:

resourceId

资源id

string

workMapId

工作地图id

string

和入参中的workMapId参数一致

2. 修改地点

请求地址

URL

https://restwia.amap.com/api/v1/wia/point/update?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

key

高德Key

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

string

必填

workMapId

高德工作地图id

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

resourceId

待修改资源id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

可选

bizSign

业务签名

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

string

必填

http body 请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

title

地点名称

string

必填

desc

描述

string

可选

imgListStr

图片集合

示例:"[{\"originalUrl\": \"http...\"}]"

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");

string

可选

pointInfoStr

标准poi信息

可以从高德地理位置编码接口获取

{"new_type":"","address":"景山前街4号故宫博物院内","adcode":"","cityCode":"110000","lon":116.395999,"phoneNumbers":"","parentID":"","transparent":"","name":"历代艺术馆","x":221008875,"y":101704042,"poiid":"B000A9PIHK","end_poi_extension":"2","lat":39.917796}

string

可选

categoryId

文件夹id

string

可选

iconFillerShowType

图标填充物类型

枚举:

1、自定义图标-填充文字(1个汉字或2个数字或字母);

2、自定义图标-填充图片;

3、预定义模板。

Integer

可选

iconFillerId

图标填充物id

『填充物类型』为1、2的时候,传『自定义图标填充物新增』接口返回的iconFillerId字段值;为3的时候传预定义的值(参考『新建地点』接口)。

string

可选

iconOutline

图标外轮廓

外轮廓枚举值参考『新建地点』接口。

『填充物类型』为2时不支持设置外轮廓。

string

可选

dimensionId

自定义字段功能Id(自定义字段分组id)

200000010000000001

string

可选

customFieldValueInfo

自定义字段集合

[{"itemId":"422206010000638001","itemType":3,"viewText":"多选测试","valueList":[{"id":"176720341784090","value":"11","remarkValue":""},{"id":"176720341866005","value":"22","remarkValue":""}]},{"itemId":"422206010000656007","itemType":1,"viewText":"文本测试预付费","valueList":[{"value":"挺有意义"}]},{"itemId":"422206010000652006","itemType":2,"viewText":"单选测试嘿嘿","valueList":[{"id":1672021515326,"value":"解决","remarkValue":""}]},{"itemId":"422206010000656008","itemType":4,"viewText":"时间太晚","valueList":[{"value":1672021560000}]}]

值的格式和含义参考『新建地点』接口

string

可选

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

为true表示修改成功

3. 删除地点

请求地址

URL

https://restwia.amap.com/api/v1/wia/point/remove?parameters

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

key

高德Key

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

string

必填

workMapId

高德工作地图id

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

resourceId

要删除的资源列表

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

可选

bizSign

业务签名

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

string

必填

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

名称

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

data

返回结果数据

object

为true表示删除成功

4. 查询单个地点详情

请求地址

URL

http://restwia.amap.com/api/v1/wia/point/detail?parameters 

请求方式

POST

请求类型ContenType

application/x-www-form-urlencoded

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

key

高德Key

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

string

必填

workMapId

高德工作地图id

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

resourceId

要查询的资源id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

可选

bizSign

业务签名

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

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 com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

  String url = "https://restwia.amap.com/api/v1/wia/point/detail";
  Map<String, Object> params = new HashMap<>();
  String workMapId = "要操作的workMapId";
  String openId = "当前操作用户的openId";
  String resourceId = "要获取的point id";
  params.put("key","在高德开放平台申请的key");
  params.put("workMapId",workMapId);
  params.put("openId",openId);
  params.put("bizToken","在高德开放平台申请的bizToken");
  String[] signArgs = new String[]{workMapId,resourceId};
  params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
  url = MyHttpUtils.attachParamsToUrl(url, params);
  
  String response = MyHttpUtils.postFormUrlencoded(url,new HashMap<>());
  System.out.println(response);
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

参数名

含义

参数说明

规则说明

code

返回结果状态值

number

返回值1 表示请求成功,3001表示不存在,3002表示已删除,其他为失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

单位毫秒

data

数据对象

object

    

title

地点名称

string

    

desc

描述

string

    

images

图片集合

string

多张图片时,半角逗号分隔

    

color

地点颜色

string

和新建地点时的含义一致

    

pointInfo

poi信息对象

object

表示点资源在哪个位置

        

name

名称

string

        

address

地址

string

poiId

poi的id

string

这个字段不一定有值

lat

维度(默认没有,需特殊申请)

string

(默认没有,需特殊申请)

lon

经度(默认没有,需特殊申请)

string

(默认没有,需特殊申请)

    

dimensionId

自定义字段功能Id

string

    

customFieldValue

自定义字段集合

array

和新建地点时的含义一致

    

showImageSwitch

显示上传的图片

number

1-开;2-关

    

category

文件夹对象

object

表示点资源在哪个文件夹

        

categoryId

文件夹id

string

        

categoryTitle

文件夹名称

string

    

principal

负责人信息,示例:

 [{

    "openId": "Cf2PHEveye_sfgxbIKNLJLNLDFLVDLVLX",

    "nickName": "test name",

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

    }]

array

iconOutline

图标外轮廓

string

iconFillerShowType

图标填充物类型

枚举:

1、自定义图标-填充文字;

2、自定义图标-填充图片;

3、预定义模板

Integer

iconFillerId

图标填充物id

『填充物类型』为1、2的时候,为『自定义图标填充物新增』接口返回的iconFillerId字段值;为3的时候为预定义填充物编号。

string

iconFillerValue

图标填充物值

『填充物类型』为3的时候没有值。

string

createUserId

创建人openId

string

createUserName

创建人昵称

string

modifiedUserId

最后修改人openId

string

modifiedUserName

最后修改人昵称

string

5. 分页查询资源列表

请求地址

URL

https://restwia.amap.com/api/v1/wia/resource/list?parameters

请求方式

POST

请求类型ContenType

application/json

parameters代表的参数为“url 请求参数”,包括必填参数和可选参数。所有参数均使用字符"&"进行分隔。下面的列表枚举了这些参数及其使用规则。

url 请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

key

高德Key

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

string

必填

workMapId

高德工作地图id

string

必填

bizToken

工作地图身份token

用户申请的工作地图身份token,一个企业一个token

string

必填

openId

当前操作人

高德用户的开放id

string

必填

sig

数字签名

请参考数字签名获取和使用方法

string

可选

bizSign

业务签名

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

string

必填

http body请求参数

参数名

含义

规则说明

参数说明

是否必须

缺省值

resourceTypes

资源类型

整数数组,枚举:1-点资源; 7-面资源

array

必填

poiInfo

用户的位置信息

json对象格式:{"lat": "纬度", "lon": "经度"}

object

可选

sortType

排序类型

整数 0-修改时间; 1-距离; 2-A-Z排序; 3-Z-A排序

number

可选

distance

限制距离范围

整数,单位为『米』

number

可选

creatorOpenIdList

创建人openId

字符串数组

array

可选

principalOpenIds

负责人openId

字符串数组

array

可选

categoryIds

文件夹id数组

字符串数组

array

可选

pageNumber

第几页

从1开始

number

必填

pageSize

每页记录条数

最大不超过50

number

必填

示例代码 (以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 com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
/*
 * 通用 import 内容等暂略
 */
public static void main(String[] args) {

  String url = "https://restwia.amap.com/api/v1/wia/resource/list";
  Map<String, Object> params = new HashMap<>();
  String workMapId = "要操作的workMapId";
  String openId = "当前操作用户的openId";
  params.put("key","在高德开放平台申请的key");
  params.put("workMapId",workMapId);
  params.put("openId",openId);
  params.put("bizToken","在高德开放平台申请的bizToken");
  String[] signArgs = new String[]{workMapId,openId};
  params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret",signArgs));
  url = MyHttpUtils.attachParamsToUrl(url, params);

  ResoureListRequest request = new ResoureListRequest();
  Integer[] resourceTypes = new Integer[]{1};
  request.setResourceTypes(resourceTypes);
  request.setPageNumber(1);
  request.setPageSize(20);
  String jsonData = JSONObject.toJSONString(request);
  
  String response = MyHttpUtils.postApplicationJson(url,jsonData);
  System.out.println(response);
}
@Data
public
class ResoureListRequest {
    private Integer[] resourceTypes;
    private PointInfoRequest poiInfo;
    private Integer sortType;
    private Integer distance;
    private String[] creatorOpenIdList;
    private String[] principalIds;
    private Integer[] categoryIds;
    private Integer pageNumber;
    private Integer pageSize;
}

返回参数

响应结果的格式为 JSON 形式。

以下是返回参数说明:

参数名

含义

参数说明

规则说明

code

返回结果状态值

number

返回值为1 表示请求成功,其他情况表示失败。

message

返回状态说明

string

当 status 为 0 时,message 会返回具体错误原因,否则返回“Successful”。详情可以参阅info状态表

timestamp

服务时间戳

number

单位毫秒

data

数据

object

    

hasMore

是否还有下一页

number

0-没有;1-有

    

currentPage

当前页码

number

    

resourceList

array

数组,里面的对象中字段如下。

        

resourceId

资源Id

string

        

resourceType

资源类型

number

整数,枚举:1-点资源

        

resourceName

资源名称

string

        

modifiedTime

修改时间

number

毫秒

        

resourceColor

资源颜色

string

和新建地点时的含义一致

        

pointInfo

poi信息对象

object

表示点资源在哪个位置

            

name

名称

string

            

address

地址

string

poiId

poi的id

string

这个字段不一定有值

lat

维度(默认没有,需特殊申请)

string

(默认没有,需特殊申请)

lon

经度(默认没有,需特殊申请)

string

(默认没有,需特殊申请)

        

creatorNickName

创建人昵称

string

        

creatorOpenId

创建人openId

string

        

categoryId

文件夹id

string

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