搜狗地图服务接口 API 参考

包含了所有开发中用到的服务接口实例以及使用方法。
使用前请您认真阅读《搜狗地图API使用条款》,如果您已开始使用,表示您已确认并同意该条款中的所有内容。
为了给您提供稳定的服务,请申请clientid,申请流程请参照用户clientid申请

参考目录

简介

    ip所在城市可以根据客户端的http请求,判断该请求来自于哪个城市

ip城市请求

ip城市请求的http网址:

//api.go2map.com/engine/api/ipcity/output?parameters

其中,output 可能是以下任何一个值:

  • json(建议)表示以 JavaScript 对象表示法 (JSON) 的形式输出
  • xml 表示以 XML 的形式输出

请求参数

参数是否必填说明
clientid 选填 clientid参数,表示客户id,用户可以通过申请获得clientid,clientid与客户的域名绑定,并根据用户权限不同绑定了访问次数的限制。如果没有clientid,则请求次数限制在每天2000次。如果访问次数超过这个限制,都需要申请clientid,以便提供更稳定的服务。
contenttype 选填 contenttype参数,用来定义返回内容的编码格式。当无此参数时默认为GBK。
cb 选填 回调函数名,可选参数。

服务响应

由请求路径中 output 指定服务的返回格式。

JSON输出

请求串:

//api.go2map.com/engine/api/ipcity/json

JSON结果显示如下所示:

{
 "response":
      {
        "level":10,
        "y":4824875,
        "ip":"61.135.178.250",
         "x":12956000,
         "city":"北京"
},
  "status":"ok"
}
                

XML输出

以下是一个HTTP请求实例:

//api.go2map.com/engine/api/ipcity/xml

XML结果显示如下所示:

<xml>
<response>
<level>10</level>
<y>4824875</y>
<ip>61.135.178.250</ip>
<x>12956000</x>
<city>北京</city>
</response>
<status>ok</status>
</xml>
                

结果说明

返回结果包括response、status两个元素。

status元素

服务返回的状态码,会返回以下两个值:

  • ok 表示服务正常,请求无误。
  • error 表示返回结果有误,可以通过解析response中的error节点,得到详细的错误信息。

response元素

response包括两中情况,输入参数无误,查询结果正常的情况,查询有误的情况。分别对应status的ok和error状态。

属性名说明
level 显示地图时的该ip所在城市适当的级别
city 该ip所对应的城市。
ip 发送该http请求的ip地址
x 该城市视野中心点的x坐标.
y 该城市视野中心点的y坐标.
error 当status为error时需要解析此节点。error节点包括id和msg两个元素,当返回status=error时,从error节点取msg显示错误信息。