搜狗地图服务接口 API 参考

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

参考目录

简介

    公交线站查询 API用于模糊查询指定城市的地铁线路、公交线路、地铁站点、公交车站点的简要信息。公交、地铁线路只返回线路的类型、名称、线路的路线坐标串、线路的聚类id,公交、地铁站点则返回站点的名称、站点坐标、站点的类型、站点的聚类id。如果需要详细信息需要根据返回结果的聚类Id查询具体的信息(查询线路具体信息,查询站点具体信息的接口在下文中将详细介绍)。

查询请求

查询请求的http网址:

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

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

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

请求参数

参数必填默认值说明
what   需要查询的地铁线路、公交线路、地铁站、公交站的名称。
pageindex 1 分页返回匹配结果的页码。
pagesize 10 分页返回的每页包含记录个数。
city   市名称 传简称即可(北京市传北京即可)。
clientid 可选   clientid参数,表示客户id,用户可以通过申请获得clientid,clientid与客户的域名绑定,并根据用户权限不同绑定了访问次数的限制。如果没有clientid,则请求次数限制在每天2000次。如果访问次数超过这个限制,都需要申请clientid,以便提供更稳定的服务。
contenttype 可选 GBK contenttype参数,用来定义返回内容的编码格式。当无此参数时默认为GBK。
cb   返回结果需要回调的函数名。主要是为浏览器js调用设计。在返回结果格式是xml的时候,此参数失效。缺省值为空。

服务响应

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

JSON输出

以下是查询114的HTTP请求实例:

//api.go2map.com/engine/api/businfo/json?what=114&pageindex=1&pagesize=30&city=北京

JSON结果显示如下所示:

{"response":{
    "areaname":"北京市",
    "resultset":{
        "curpage":1,
        "pagesize":30,
        "pagecount":1,
        "curresult":4,
        "data":{
            "feature":[
                {
                    "subcategorytxt":"公交线路",
                    "id":1000076326661,
                    "Style":{
                        "id":""
                    },
                    "Label":{
                        "position":"",
                        "style":"Label01",
                        "on":true
                    },
                    "cpid":1,
                    "caption":"114(白云路-南坞)",
                    "Points":{
                        "txt":"1.295064E7,4824114.0,1.2950627E7,..."
                    },
                    "dataid":"D1000076326661",
                    "clustering":2
                },
               其他结果...
            ]
        },
        "resultcount":4,
        "qrflag":"name"
    },
    "mapservice":"busex.BusInfo"
},"status":"ok"}
                

XML输出

以下是查询114的HTTP请求实例:

//api.go2map.com/engine/api/businfo/xml?what=114&pageindex=1&pagesize=30&city=北京

XML结果显示如下所示:

<xml>
    <response>
        <areaname>北京市</areaname>
        <resultset>
            <curpage>1</curpage>
            <pagesize>30</pagesize>
            <pagecount>1</pagecount>
            <curresult>4</curresult>
            <data>
                <feature>
                    <subcategorytxt>公交线路</subcategorytxt>
                    <id>1000076326661</id>
                    <Style>
                        <id/>
                    </Style>
                    <Label>
                        <position/>
                        <style>Label01</style>
                        <on>true</on>
                    </Label>
                    <cpid>1</cpid>
                    <caption>114(白云路-南坞)</caption>
                    <Points>
                        <txt>
                            1.295064E7,4824114.0,...
                        </txt>
                    </Points>
                    <dataid>D1000076326661</dataid>
                    <clustering>2</clustering>
                </feature>
                其他信息...
            </data>
            <resultcount>4</resultcount>
            <qrflag>name</qrflag>
        </resultset>
        <mapservice>busex.BusInfo</mapservice>
    </response>
    <status>ok</status>
</xml>
                

结果说明

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

status元素

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

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

response元素

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

属性名说明
areaname 查询的区域。
resultset 主要的结果对象。查询结果对象。详情请查看resultset元素
error 当status为error时需要解析此节点。error节点包括id和msg两个元素。错误情况:
id= 205 msg=“抱歉, 所在城市不支持公交换乘!“;
id= 224 msg=”抱歉,没有找到任何与所输关键字相关的信息!“

resultset元素

属性名说明
curpage 当前结果集合的页码。
pagesize 返回结果每页结果数量。
pagecount 结果的总页数。
curresult 当前结果数量。
resultcount 匹配的结果的总数。
data 数据元素集合。包含具体的数据信息。一个feature元素代表一个数据结果。详细信息请查看feature元素。

feature元素

属性名说明
subcategorytxt feature元素的类型。包括:“公交线路”,“公交车站”,“地铁线”,“地铁站”
id 聚类id,在查找详细信息中需要用到此id。
dataid 数据的id,在id前面加个D。
caption 结果的名称。
Points 坐标信息,具体的坐标信息存放在txt属性中,未加密的,格式:x,y,x,y…。