Appearance

定位API开发指南 ​

基本信息 ​

  • 华风爱科 API提供给用户一个简洁的RESTful Web接口，用以访问基于位置的天气数据。
  • 用户可以通过输入经纬度坐标查询全球城市。
  • 用户可以输入全球城市名称查询位置。
  • 使用GeoLookup通过经度和纬度坐标进行搜索。GeoLookups在中国大陆地区应使用GCJ-02坐标系，在其他地区应使用WGS-84坐标系统。
  • 数据支持中英文语言。如需要更多语言与本地化方言请联系商务。
  • 默认情况下，将不返回位置的具体细节。请通过传递“details=true”查看该位置的相关细节。

API服务地址 ​

请求URL ​
类型URL请求方式
通过GeoPosition搜索城市（纬度/经度）https://openapi.weathercn.com/locations/{version}/cities/geoposition/search{.{format}}?q={latitude, longitude}&apikey=<用户的key>{&language={language code}}{&details={true or false}}GET
文本搜索https://openapi.weathercn.com/locations/{version}/cities/translate{.{format}}?q={city name}&apikey=<用户的key>{&language={language code}}{&details={true or false}}GET
请求参数 ​
参数说明默认值
apikey用以在API里验证与授权使用的用户密钥N/A必选
version当前API版本v1必选
q匹配文字N/A必选
locationkey用以搜索指定地点的特定IDN/A必选
format响应格式JSON可选
language指定响应数据语言的字符串zh-cn可选
details用以判断是否在地点里包括相关细节的布尔值False可选
返回参数 ​
参数说明
Version当前API版本
Key用以搜索指定地点的特定ID
Type定位种类（城市，邮编，兴趣点或经纬度）
Rank取决于地点人口，政治重要性以及地理大小因素的排名数
LocalizedNameURL显示根据语言代码的本地化地点名称。 默认为US English (us-en) 美式英语
EnglishName地点英文名
PrimaryPostalCode由定位数据供应商提供的定位官方邮编号码
Region地区
ID定位的特定地区代码
LocalizedNameURL显示根据语言代码的本地化地区名称。默认为US English (-en) 美式英语
EnglishName地区英文名
Country国家
ID国家的特定ISO或 Microsoft Localization Code 微软本地化代码
LocalizedNameURL显示根据语言代码的本地化国家名称。默认为US English (us-en) 美式英语
EnglishName国家英文名
AdministrativeArea行政区域
ID行政区域的特定代码ID
LocalizedNameURL显示根据语言代码的本地化行政区域名称。默认为US English (us-en) 美式英语
EnglishName行政区域英文名
Level用以判断行政分区等级的排名数字，等级越高，分区规模越小。10或更高的数字保留给非政治边界，需分开使用
LocalizedTypeURL显示根据语言代码的本地化行政区域种类。默认为US English (us-en) 美式英语
EnglishType行政区域种类英文名
CountryID行政区域的特定ISO或 Microsoft Localization Code 微软本地化代码
TimeZone时区
Code指定时区的官方缩写代码
Name指定时区的官方名称
GmtOffset与GMT格林威治标准时间相差的小时数
IsDaylightSaving判断当前是否处于夏令时间，判断结果响应为true“是”或false“否”
NextOffsetChange下次夏令时变更时间
GeoPosition地理定位
Latitude纬度，用以确定一点在地球表面上的南北位置
Longitude经度，用以确定一点在地球表面上的东西位置
Elevation海拔
Metric公制（米）
Value单位的海拔凑整值
Unit海拔值使用的单位种类
UnitType与显示单位种类关联的数字ID
Imperial英制（英尺）
Value单位的海拔凑整值
Unit海拔值使用的单位种类
UnitType与显示单位种类关联的数字ID
IsAlias判断一个地点是否使用别名的布尔值。true“是” 或false“否”
ParentCity仅当该位置是较大城市或区县，才会显示此对象。
KeyParent city location key
LocalizedNameURL显示根据语言代码的本地化地点名称。 默认为US English (us-en) 美式英语
EnglishName英文名
SupplementalAdminAreas附加行政区域
Level用以判断行政子分区等级的排名数字，等级越高，子分区规模越小。10或更高的数字保留给非政治边界，需分开使用
LocalizedNameURL显示根据语言代码的本地化行政分区名称。默认为US English (us-en) 美式英语
EnglishName行政分区英文名
Details特定地点的相关细节
Key用以识别指定地点的特定ID
StationCode指定地点的气象站点代码
StationGmtOffset指定地点的气象站点的GMT offset时差
BandMap气温与降水量的band map code
Climo指定地点的气候数据来源
LocalRadar指定地点关联的本地雷达代码
MediaRegion指定地点的关联的媒体地区
Metar指定地点的航空例行天气报告站点
NXMetro市级雷达代码
NXState州级雷达代码
Population指定地点的上报人口
PrimaryWarningCountyCode首要警报县代码
PrimaryWarningZoneCode首要警报区代码
Satellite指定地点的关联的卫星代码
Synoptic指定地点的关联的气象站点
MarineStation海洋站点代码
MarineStationGMTOffset海洋站点GMT offset时差
VideoCode视频用城市或地区识别代码
PartnerID用于在the Designated Marketing Area (DMA指定营销地区)上识别展示合作方的特定数字ID。语言依赖
DMADesignated Marketing Area (DMA指定营销地区)
ID用以识别营销区域的数字ID
EnglishNameDesignated Marketing Area
Sources分类官方数据来源
DataType数据来源所提供的数据类型
Source数据来源方名称
SourceId与数据来源相关联的ID
CanonicalPostalCode最佳化的邮编号码。可以是特定地点或附近城市区域的邮编。可空白。
CanonicalLocationKey最佳化的locationkey。可以是特定地点或附近城市区域的locationkey。可空白。
调用示例 ​

  1. 通过GeoPosition搜索城市（纬度/经度）

    以下将展示一个经纬度定位的示例

    json
    https://openapi.weathercn.com/locations/v1/cities/geoposition/search.json?q=39.95,116.328&apikey=<用户的key>&language=zh-cn&details=true

    在线体验

  2. 按文本搜索

    以下将展示如何以名称（如：北京）搜索地点

    json
    https://openapi.weathercn.com//locations/v1/cities/translate?q=北京&apikey=<用户的key>&language=zh-cn&details=true

    在线体验