ScanPoisForSDK - 获取指定城市的POI列表--内容定制-火山引擎

文档中心

立即注册

导航

ScanPoisForSDK - 获取指定城市的POI列表

最近更新时间：2024.11.01 14:03:09首次发布时间：2024.11.01 14:03:09

使用游标获取指定城市下的POI列表。

请求说明

请求方式：POST
请求地址：https://mercury.volcengineapi.com?Action=ScanPoisForSDK&Version=2024-01-01
请求头：
- ServiceName:volc_torchlight_api
- Content-Type:application/json

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	ScanPoisForSDK	要执行的操作，取值：ScanPoisForSDK。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号。
CityCode	String	是	110000	六位行政区划代码，例如“110000”，“210100”；详细枚举参考 https://www.mca.gov.cn/mzsj/xzqh/2022/202201xzqh.html
NextToken	String	否	7425984067354002956	分页获取下一页内容的游标；不传递则返回第一页数据。
MaxResults	Integer	否	10	返回每页的条数。默认值为10；最大值为1000；不填或非法输入则返回10条数据。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	7425984067354002956	下一页内容的分页游标
Pois	Array of Object		poi列表

请求示例

POST /?Action=ScanPoisForSDK&Version=2024-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=ScanPoisForSDK&Version=2024-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T055410Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241031/cn-beijing/volc_torchlight_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UtmSource": "xxx_default_content",
  "CityCode": "110000"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241031135430081027033087670653",
    "Action": "ScanPoisForSDK",
    "Version": "2024-01-01",
    "Service": "volc_torchlight_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "NextToken": "7425984067354002956",
    "Pois": [
      {
        "PoiId": "6601123777029867533",
        "ParentId": "0",
        "Name": "POI 名称",
        "ProvinceCode": "11",
        "CityCode": "110000",
        "DistrictCode": "110105",
        "Address": "POI 地址",
        "Categories": [
          {
            "Code": "180000",
            "Name": "游玩",
            "SubNodes": []
          }
        ],
        "Longitude": 116.393092,
        "Latitude": 40.009939,
        "QualityRank": 100,
        "CreateTime": 1536943898
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。