地点资源 最后更新时间: 2024年08月30日

产品介绍

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

适用场景

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

使用限制

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

使用说明

接收请求返回的数据（JSON或XML格式），参考返回参数文档解析数据。

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

1. 新建地点

请求地址

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

url 请求参数

http body 请求参数

示例代码 （以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 形式。

以下是返回参数说明：

2. 修改地点

请求地址

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

url 请求参数

http body 请求参数

示例代码 （以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/update";
    Map<String, Object> params = new HashMap<>();
    String workMapId = "工作地图id";
    String resourceId = "待修改资源id";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", "当前操作用户的openId");
    params.put("bizToken", "在高德开放平台申请的bizToken");
    params.put("workMapId", workMapId);
    String[] signArgs = new String[]{workMapId, resourceId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("resourceId", resourceId);
    params.put("title", "修改后的资源标题");

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

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

以下是返回参数说明：

3. 删除地点

请求地址

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

url 请求参数

示例代码 （以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/remove";
    Map<String, Object> params = new HashMap<>();
    String workMapId = "工作地图id";
    String resourceId = "待删除资源id";

    params.put("key", "在高德开放平台申请的key");
    params.put("openId", "当前操作用户的openId");
    params.put("bizToken", "在高德开放平台申请的bizToken");
    params.put("workMapId", workMapId);
    String[] signArgs = new String[]{workMapId, resourceId};
    params.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", signArgs));

    params.put("resourceId", resourceId);

    String response = MyHttpUtils.postFormUrlencoded(url, params);
    System.out.println(response);
}

返回参数

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

以下是返回参数说明：

4. 查询单个地点详情

请求地址

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

url 请求参数

示例代码 （以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 形式。

以下是返回参数说明：

5. 分页查询资源列表

请求地址

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

url 请求参数

http body请求参数

示例代码 （以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 形式。

以下是返回参数说明：

6. 游标查询资源列表 - 未开放

请求地址

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

url 请求参数

http body请求参数

示例代码 （以java为例）

    @Test
    public void  test01(){

        // 资源路径
        Strin requestUrl = "https://restwia.amap.com/api/v1/wia/resource/scroll/query";
      
        //param 入参
        Map<String, Object> params1 = new HashMap<>();
        params1.put("workMapId","工作地图id");
        params1.put("bizToken","在高德开放平台申请的bizToken");
        params1.put("openId","当前操作用户的openId");
        params1.put("bizSign", SignatureHelper.calcSign("在高德开放平台申请的bizSecret", new String[]{"工作地图id","openId"}));//业务签名
        params1.put("key","在高德开放平台申请的key");
      
        //body 入参
        Map<String, Object> params2 = new HashMap<>();
        //游标 首次调用传空，非首次使用前一页返回结果进行滚动查询
        params2.put("token",null);
        //页容量 默认50
        params2.put("pageSize",10);
        //资源类型
        ArrayList<Integer> types = Lists.newArrayList();
        types.add(1);//点资源
        types.add(7);//面资源
        params2.put("resourceTypes",types);
        //创建人openIds
        ArrayList<String> openIds = Lists.newArrayList();
        openIds.add(env.getOpenId());
        params2.put("createOpenIds",openIds);
        //负责人openIds
        params2.put("principalOpenIds",openIds);
        //文件夹
        ArrayList<String> categoryIds = Lists.newArrayList();
        categoryIds.add("-1");
        params2.put("categoryIds",categoryIds);
        //时间查询
        Map<String, Object> resourceTimeQuery = new HashMap<>();
        resourceTimeQuery.put("timeType",1);
        resourceTimeQuery.put("beginTime",1683701973000l);
        resourceTimeQuery.put("endTime",1715324373000l);
        params2.put("resourceTimeQuery", JSONObject.toJSONString(resourceTimeQuery));
      
        requestUrl = MyHttpUtils.attachParamsToUrl(requestUrl,params1);
        String response = MyHttpUtils.postApplicationJson(requestUrl,JSONObject.toJSONString(params2));
        System.out.println(response);

    }

返回参数

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

以下是返回参数说明：

返回实例

{
    "data": {
        "resourceList": [
            {
                "resourceId": "2003003712757469",
                "resourceType": 1,
                "resourceName": "北苑中街11-8号",
                "resourceColor": 1,
                "modifiedTime": 1711096504223,
                "createTime": 1711096504223,
                "creatorNickName": "陆小果",
                "creatorOpenId": "V3xV8qFTbNEMSlcqDUZqG4RCm0x7rClI9GH-HM2pr66ndJTHzKsCuHc4pOyjTN1n",
                "pointInfo": {
                    "name": "北苑中街11-8号",
                    "address": "北京市朝阳区北苑中街11-8号",
                    "lat": "40.028109",
                    "lon": "116.437968"
                },
                "categoryId": "-1"
            },
            {
                "resourceId": "2003003712794017",
                "resourceType": 1,
                "resourceName": "望京西路35号",
                "resourceColor": 1,
                "modifiedTime": 1712830337198,
                "createTime": 1712830337198,
                "creatorNickName": "陆小果",
                "creatorOpenId": "V3xV8qFTbNEMSlcqDUZqG4RCm0x7rClI9GH-HM2pr66ndJTHzKsCuHc4pOyjTN1n",
                "pointInfo": {
                    "name": "望京西路35号",
                    "address": "北京市朝阳区望京西路35号",
                    "lat": "39.998801889370704",
                    "lon": "116.4560622519608"
                },
                "categoryId": "-1"
            },
            {
                "resourceId": "2003003712803438",
                "resourceType": 1,
                "resourceName": "来广营西路88号",
                "resourceColor": 1,
                "modifiedTime": 1715251322247,
                "createTime": 1715251322247,
                "creatorNickName": "陆小果",
                "creatorOpenId": "V3xV8qFTbNEMSlcqDUZqG4RCm0x7rClI9GH-HM2pr66ndJTHzKsCuHc4pOyjTN1n",
                "pointInfo": {
                    "name": "来广营西路88号",
                    "address": "北京市朝阳区来广营西路88号",
                    "lat": "40.021561070070476",
                    "lon": "116.43059061451024"
                },
                "categoryId": "-1"
            }
        ],
        "nextToken": null,
        "hasMore": 0,
        "count":3
    },
    "code": 1,
    "message": "Successful",
    "result": true,
    "version": "1.0",
    "timestamp": 1715328186655,
    "requestId": "2133739b17153281854355462e76fd"
}