爱帮网
 
首页 > API

API 使用说明

(一)读API定义

通用说明

  • 协议

    爱帮API的输入参数和输出结果均使用UTF-8编码,采用HTTP协议GET请求。爱帮API每次查询最多返回10条记录,支持分页查询。

  • 通用参数

    通用参数是所有“读”API都需要传送的参数。

    参数 类型 是否可选 意义 备注
    app_key string 应用标识码 爱帮要求每个应用都必须申请一个AppKey,以防止接口被滥用或恶意使用
    alt string 返回的数据格式 目前只能是xml, json,默认xml
  • 返回状态

    爱帮API通过HTTP Status Code说明API调用是否成功,以下是可能返回状态及其含义:

    状态码 含义
    200 OK 请求成功
    400 BAD REQUEST 请求参数不符合API规定
    401 UNAUTHORIZED 未授权
    404 NOT FOUND 资源不存在
    500 INTERNAL SERVER ERROR 内部错误

    当状态码是200时,正文是查询结果。在其它情况下,正文包含字段message,说明可能的的错误原因。若采用XML作为返回结果格式,则类似于:

    <?xml version=”1.0” encoding=”UTF-8”?> <root> <message>参数缺少app_key</message> </root>
  • 说明

    商户搜索接口根据指定的城市、地址(或坐标)和关键词等参数查询满足条件的商户,返回商户列表。如果不指定地址(或坐标),则在全市搜索。若不指定关键字,则返回地址周边的商户。地址(或坐标)和关键字必须至少有一个。

    最多返回前300个满足指定搜索条件的商户。

  • 形式

    http://openapi.aibang.com/search

    例如:http://openapi.aibang.com/search?app_key=f41c8afccc586de03a99c86097e98ccb&city=%E5%8C%97%E4%BA%AC&q=%E9%A4%90%E9%A6%86

    参数说明
    参数 类型 是否可选 意义 备注
    city string 城市
    a string 地址 地址分为区域地址(如海淀区)和点地址(如安全大厦),区域地址的查询不受距离参数as的限制;若是点地址,则以此作为中心点,以as为半径的区域内搜索
    lng float 经度 地址的经度
    lat float 纬度 地址的纬度
    q string 关键字 如:餐馆、ktv、火车站、北京饭店
    cate string 类别 限于爱帮类别列表
    rc int 排序方法 1:默认排序,根据综合因素排序; 2:按距离排序; 3:按可信度排序; 5:按热度排序; 6:按照星级排序; 注:由于爱帮会根据查询分析将更匹配和准确的结果放在前面,以上排序仅作参考使用
    as int 距离限制 0:无限制,默认; 负数:建议限制距离为其绝对值,但搜索引擎若认为结果不好则扩展至全市搜索; 正数:强制在此距离范围内
    from int 返回结果在总结果的起始位置 最小为1,默认为1,(最多为300)
    to int 返回结果在总结果中的结束位置 默认from+9,(最多为300)。结果为from和to组成闭区间[from, to]

    附加说明:参数中地址a和经纬度lng|lat都可以指定中心点,如果只指定了a而没有lng|lat,则在a指定的地址范围内查询,搜索引擎会根据地址a计算对应的中心点;如果只指定了lng|lat而没有a,则以lng|lat指定的经纬度作为中心点;如果同时指定a和lng|lat,则在地址a范围内检索,同时把lng|lat指定的中心点作为a对应的中心点。

  • 返回内容

    该API返回一定数量的商户信息,如下:

    <?xml version="1.0" encoding="utf-8" ?> <root> <index_num>121286</index_num> <total>300</total> <result_num>10</result_num> <web_url>http://www.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <bizs> <biz> <id>17700376-419866368</id> <name>巫山烤全鱼(交大店)</name> <addr>西城区西直门交大东路46号(佰金KTV对面胡同里)</addr> <tel>010-51562760</tel> <cate>烤鱼;美食;川菜;烧烤</cate> <rate>4</rate> <cost>0</cost> <desc>江边城外·巫山烤全鱼 北京江边城外餐饮管理有限公司,成立于2006年,是一家专业的连锁餐饮...</desc> <dist>-1</dist> <lng>116.3492255</lng> <lat>39.950558</lat> <img_url>http://img0.aibangjuxin.com/ipic/f5f9631bec2d9fea_8.jpg</img_url> </biz> ... </bizs> </root>
    字段 类型 意义 备注
    index_num int 检索的结果总数 检索中所有匹配的记录数量
    total int 总记录数 接口返回的商户记录总数(最多300)
    result_num int 返回的记录数 当前请求返回的结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    id string 商户ID 爱帮商户ID的格式是INT-INT,即中短线连接的两个整数
    name string 商户名
    addr string 商户地址
    tel string 商户电话号码
    cate string 商户类别 可为多个,以半角分号;(英文分号)分隔
    rate float 商户星级 范围1~5,0表示未评级
    cost int 人均消费 单位:元,0表示无消费或未知消费
    desc string 商户简介
    dist int 与中心点距离 单位是千米,-1表示距离无效
    lng float 经度 商户所在位置的经度
    lat float 纬度 商户所在位置的纬度
    img_url string 商户图片url

定位

获取商户详情

  • 说明

    商户信息查询接口。通过这个接口查询指定商户的信息。

  • 形式

    http://openapi.aibang.com/biz/{id}

    例如:http://openapi.aibang.com/biz/2029602847-421506714?app_key=f41c8afccc586de03a99c86097e98ccb

    参数说明
    参数 类型 是否可选 意义 备注
    id string 商户ID
  • 返回内容

    该API返回商户信息,如下:

    <?xml version="1.0" encoding="utf-8" ?> <root> <biz> <id>2029602847-421506714</id> <name>海底捞火锅(劲松店)</name> <county>朝阳区</county> <addr>朝阳区南磨坊路29号(近西大望路)</addr> <tel>010-87798677 010-87798911</tel> <cate>美食;川菜;其他川菜;火锅;其他火锅</cate> <rate>4.2</rate> <cost>56</cost> <desc>海底捞餐饮有限责任公司成立于1994年,是一家以经营川味火锅为主,融汇各地火锅特色为一体的大型连锁餐饮 民营企业。公司自成立以来,始终奉行“服务至上,顾客至上”的理念,以贴心,周到,优质的服务,赢得了纷至沓来的顾客 和社会广泛赞誉.公司始终高扬... </desc> <lng>116.4728879</lng> <lat>39.88489474</lat> <work_time>周一 至 周日 10:00-24:00</work_time> <site_url>http://www.haidilao.com/</site_url> <web_url>http://www.aibang.com/detail/2029602847-421506714</web_url> <wap_url>http://wap.aibang.com/detail/2029602847-421506714</wap_url> <img_url>http://img0.aibangjuxin.com/ipic/94da23f73e83c1b_8.jpg</img_url> </biz> </root>
    字段 类型 意义 备注
    id string 商户ID
    name string 商户名
    county string 区县 商户所在地区或者县
    addr string 商户地址
    tel string 商户电话号码
    cate string 商户类别 可为多个,以半角分号;(英文分号)分隔
    rate float 商户星级 范围1~5,0表示未评级
    cost int 人均消费 单位:元,0表示无消费或未知消费
    desc string 商户简介
    lng float 经度 商户所在位置的经度
    lat float 纬度 商户所在位置的纬度
    work_time string 营业时间
    site_url string 官方网站url
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    img_url string 商户图片url

获取商户评论

  • 说明

    商户点评查询,该接口查询指定商户的点评。(最多一次返回30条记录)

  • 形式

    http://openapi.aibang.com/biz/{id}/comments

    例如:http://openapi.aibang.com/biz/17624584-419889778/comments?app_key=f41c8afccc586de03a99c86097e98ccb

    参数说明
    参数 类型 是否可选 意义 备注
    id string 商户ID
    from int 返回结果在总结果的起始位置 最小为1,默认为1
    to int 返回结果在总结果中的结束位置 默认from+9,最多为from+29(30条记录)。结果为from和to组成的闭区间[from, to]
  • 返回内容

    该API返回指定id对应商户的点评信息。

    <?xml version="1.0" encoding="utf-8" ?> <root> <total>983</total> <result_num>10</result_num> <web_url>http://www.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <comments> <comment> <uid>0</uid> <uname>冬天里的冬天</uname> <avatar_url>http://i0.aibangjuxin.com/images/user_wde.png</avatar_url> <space_url></space_url> <pubtime>1311165863</pubtime> <score>4</score> <cost>0</cost> <content>烤鸭很好吃,特别喜欢鸭胸上的几块小鸭皮,肥而不腻,脆而不焦,蘸上白糖,GOOD~服务还好, 不过这10%的服务费就没王府井的值,也没人给讲一下小鸭子的历史,不太好~环境一般,反正全聚德都挺拥挤的~ </content> </comment> ... </comments> </root>
    字段 类型 意义 备注
    total int 记录总数 该商户的点评总量
    result_num int 返回的记录数 当前请求返回的结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    uid int 用户ID 发表该点评的用户的ID(非爱帮用户为0)
    uname string 用户名 发表该点评的用户的名称
    avatar_url string 用户头像url 发表该点评的用户的头像url,大小是48*48
    space_url string 爱帮web站用户空间url 爱帮每个用户有自己的用户空间,此为发表该点评的用户的空间url(仅爱帮用户有)
    pubtime string 发帖时间 发表该点评的时间(unix时间戳,北京时间)
    score int 打分 介于[1,5]的整数
    cost int 人均消费 0表示无消费或消费未知
    content string 点评内容 纯文本的点评内容

获取商户图片

  • 说明

    商户图片查询,该接口查询指定商户的图片。(最多一次返回30条记录)

  • 形式

    http://openapi.aibang.com/biz/{id}/pics

    例如:http://openapi.aibang.com/biz/17624584-419889778/pics?app_key=f41c8afccc586de03a99c86097e98ccb

    参数说明
    参数 类型 是否可选 意义 备注
    id string 商户ID
    from int 返回结果在总结果的起始位置 最小为1,默认为1
    to int 返回结果在总结果中的结束位置 默认from+9,最多为from+29(30条记录)。结果为from和to组成的闭区间[from, to]。
  • 返回内容

    该API返回指定id对应商户的点评信息。

    <?xml version="1.0" encoding="utf-8" ?> <root> <total>16</total> <result_num>10</result_num> <web_url>http://www.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <pics> <pic> <uid>0</uid> <uname></uname> <avatar_url>http://i0.aibangjuxin.com/images/user_wde.png</avatar_url> <space_url></space_url> <pubtime>1247745943</pubtime> <title>[全聚德烤鸭店前门店]点心</title> <url>http://img0.aibangjuxin.com/ipic/9f4bbdac35b76a2f_0.jpg</url> <thumbnail_url>http://img0.aibangjuxin.com/ipic/9f4bbdac35b76a2f_8.jpg</thumbnail_url> </pic> ... </pics> </root>
    字段 类型 意义 备注
    total int 记录总数 该商户的点评总量
    result_num int 返回的记录数 当前请求返回的结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    uid int 用户ID 发表该图片的用户的ID(非爱帮用户为0)
    uname string 用户名 发表该图片的用户的名称(如果来自网上,则可能为空)
    avatar_url string 用户头像url 发表该图片的用户的头像url,大小是48*48
    space_url string 爱帮web站用户空间url 爱帮每个用户有自己的用户空间,此为发表该图片的用户的用户空间url(仅爱帮用户有)
    pubtime string 发表时间 发表该图片的时间(unix时间戳,北京时间)
    title string 图片标题
    url string 图片的url
    thumbnail_url string 缩略图的url 缩略图的大小为100*100

公交驾乘查询

  • 说明

    公交换乘查询,该接口根据起点和终点信息查询公交换乘方案。

  • 形式

    http://openapi.aibang.com/bus/transfer

    例如:http://openapi.aibang.com/bus/transfer?app_key=f41c8afccc586de03a99c86097e98ccb&city=%E5%8C%97%E4%BA%AC&start_addr=%E8%A5%BF%E7%9B%B4%E9%97%A8&end_addr=%E4%B8%9C%E7%9B%B4%E9%97%A8

    参数说明
    参数 类型 是否可选 意义 备注
    city string 城市
    start_addr string 起点 如:五道口,与start_lng和start_lat不能都为空
    end_addr string 终点 如:东直门,与end_lng和end_lat不能都为空
    start_lng float 起点经度
    start_lat float 起点纬度
    end_lng float 终点经度
    end_lat float 终点纬度
    rc int 排序方式 默认是0,定义如下: 0:综合排序 1:换乘次数 2:步行距离 3:时间 4:距离 5:地铁优先
    count int 最大返回记录数量 默认为10,最大值不能超过10
    with_xys int 是否包含坐标信息 默认为0,不包含各个站点和路线的坐标信息,如果为1,则包含
  • 返回内容

    该API返回换乘方案。

    <?xml version="1.0" encoding="utf-8" ?> <root> <result_num>10</result_num> <web_url>http://bus.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <buses> <bus> <dist>9242</dist> <time>29</time> <foot_dist>597</foot_dist> <last_foot_dist>597</last_foot_dist> <segments> <segment> <start_stat>西直门</start_stat> <end_stat>东四十条</end_stat> <line_name>地铁2号线内环(M2)(积水潭-积水潭)</line_name> <stats>西直门;积水潭;鼓楼大街;安定门;雍和宫;东直门;东四十条</stats> <line_dist>8645</line_dist> <foot_dist>0</foot_dist> <stat_xys></stat_xys> <line_xys></line_xys> </segment> </segments> </bus> ... </buses> </root>
    字段 类型 意义 备注
    result_num int 结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    dist int 总距离 单位:米
    time int 估计耗费时间 单位:分钟
    foot_dist int 总步行距离 单位:米
    last_foot_dist int 从终点站走到终点的距离 单位:米
    start_stat string 起点站名
    end_stat string 终点站名
    line_name string 线路名称
    stats string 沿途站点 半角分号;(英文分号)分隔
    line_dist int 行驶距离 单位:米
    foot_dist int 步行距离 单位:米
    stat_xys string 途径站点经纬度 经度与纬度用半角逗号,(英文逗号)分隔;每组经纬度用半角分号;(英文分号)分隔
    line_xys string 途径线路经纬度 经度与纬度用半角逗号,(英文逗号)分隔;每组经纬度用半角分号;(英文分号)分隔

公交线路查询

  • 说明

    公交线路查询,该接口根据关键字查询匹配的线路。

  • 形式

    http://openapi.aibang.com/bus/lines

    例如:http://openapi.aibang.com/bus/lines?app_key=f41c8afccc586de03a99c86097e98ccb&city=%E5%8C%97%E4%BA%AC&q=42

    参数说明
    参数 类型 是否可选 意义 备注
    city string 城市
    q string 关键字 如:466、1路
    with_xys int 是否包含坐标点信息 默认为0,不包含各个站点和路线的坐标信息,如果为1,则包含
  • 返回内容

    该API返回线路方案。

    <?xml version="1.0" encoding="utf-8" ?> <root> <result_num>13</result_num> <web_url>http://bus.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <lines> <line> <name>42路(东40条桥-广外甘石桥)</name> <info>1-599路; 东四十条桥5:30-23:00|广外甘石桥5:30-23:00; 无人售票线路,单一票制1元,不设找赎。 持卡乘车普通卡0.40元/次、学生卡0.20元/次。 </info> <stats>东四十条桥;张自忠路;宽街路口东;地安门东;北海北门;厂桥路口东;平安里路口南;西四路口西;白塔寺; 阜成门内;阜成门南;月坛体育场;北京儿童医院西门;礼士路南口;真武庙;天宁寺桥北;广安门北;广外关厢;达官营; 广外甘石桥 </stats> <stat_xys></stat_xys> <xys></xys> </line> ... </lines> </root>
    字段 类型 意义 备注
    result_num int 结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    name string 线路名称
    info string 线路信息 包括线路类型、票价、首末班车时间等
    stats string 沿途站点 半角分号;(英文分号)分隔
    stat_xys string 途径站点经纬度 经度与纬度用半角逗号,(英文逗号)分隔;每组经纬度用半角分号;(英文分号)分隔
    xys string 线路坐标 线路本身对应的各个坐标点,经度与纬度用半角逗号,(英文逗号)分隔;每组经纬度用半角分号;(英文分号)分隔

公交站点查询

  • 说明

    公交站点查询,该接口根据关键字查询匹配的站点。

  • 形式

    http://openapi.aibang.com/bus/stats

    例如:http://openapi.aibang.com/bus/stats?app_key=f41c8afccc586de03a99c86097e98ccb&city=%E5%8C%97%E4%BA%AC&q=%E4%BA%94%E9%81%93%E5%8F%A3

    参数说明
    参数 类型 是否可选 意义 备注
    city string 城市
    q string 关键字 如:大羊坊、五道口
  • 返回内容

    该API返回站点方案。

    <?xml version="1.0" encoding="utf-8" ?> <root> <result_num>4</result_num> <web_url>http://bus.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <stats> <stat> <name>城铁五道口站</name> <xy>116.33912,39.99303</xy> <line_names>375路(西直门-韩家川);375路(韩家川-西直门北);398路(育新小区-5道口公交场站); 398路(5道口公交场站-育新小区) </line_names> </stat> ... </stats> </root>
    字段 类型 意义 备注
    result_num int 结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    name string 站点名称
    xy string 站点坐标 半角逗号,(英文逗号)分隔
    line_names string 途径该站点的线路名称 半角分号;(英文分号)分隔

周边公交站点查询

  • 说明

    周边公交站点查询,该接口根据经纬度坐标查询其附近的站点。

  • 形式

    http: //openapi.aibang.com/bus/stats_xy

    例如:http://openapi.aibang.com/bus/stats_xy?app_key=f41c8afccc586de03a99c86097e98ccb&city=%E5%8C%97%E4%BA%AC&lng=116.33785&lat=39.99285&dist=500

    参数说明
    参数 类型 是否可选 意义 备注
    city string 城市
    lng float 经度
    lat float 纬度
    dist float 距离 单位:米
  • 返回内容

    该API返回周边站点方案。

    <?xml version="1.0" encoding="utf-8" ?> <root> <result_num>5</result_num> <web_url>http://bus.aibang.com</web_url> <wap_url>http://wap.aibang.com</wap_url> <stats> <stat> <name>城铁五道口站</name> <xy>116.33764,39.99291</xy> <dist>18</dist> <line_names>375路(西直门-韩家川);375路(韩家川-西直门北);398路(育新小区-5道口公交场站); 398路(5道口公交场站-育新小区) </line_names> </stat> ... </stats> </root>
    字段 类型 意义 备注
    result_num int 结果数量
    web_url string 爱帮web站对应url
    wap_url string 爱帮wap站对应url
    name string 站点名称
    xy string 站点坐标 半角逗号,(英文逗号)分隔
    dist int 距离输入经纬度坐标的距离 单位:米
    line_names string 途径该站点的线路名称 半角分号;(英文分号)分隔

(二)写API定义

通用说明

  • 协议

    爱帮“写”API的输入参数和输出结果均使用UTF-8编码,采用HTTP协议POST请求。

  • 通用参数

    通用参数是所有“写”API都需要传送的参数。

    参数 类型 是否可选 意义 备注
    app_key string 应用标识码 爱帮要求每个应用都必须申请一个AppKey,以防止接口被滥用或恶意使用
    uname string 用户名 在App上的用户名,字节数不大于30B
    alt string 返回的数据格式 目前只能是xml, json,默认xml
  • 返回状态

    爱帮API通过HTTP Status Code说明API调用是否成功,以下是可能返回状态及其含义:

    状态码 含义
    200 OK 请求成功
    400 BAD REQUEST 请求参数不符合API规定
    401 UNAUTHORIZED 未授权
    404 NOT FOUND 资源不存在
    500 INTERNAL SERVER ERROR 内部错误

    正文包含字段message,说明可能的的错误原因。若采用XML作为返回结果格式,则类似于:

    <?xml version=”1.0” encoding=”UTF-8”?> <root> <message>参数缺少app_key</message> </root>

发表商户点评

  • 说明

    对指定商户发表点评。

  • 形式

    http:// openapi.aibang.com/biz/{id}/comment

    例如:http:// openapi.aibang.com/biz/971877911-703465332/comment?app_key=f41c8afccc586de03a99c86097e98ccb&uname=api_user

    参数说明
    参数 类型 是否可选 意义 备注
    id string 商户ID
    score int 打分 对该商户的综合打分,介于[1,5]之间的整数
    content string 内容 发表点评的内容,最少10个字符,最多1000个字符
    cost int 人均消费 单位:元

发表商户图片

  • 说明

    对指定商户发表图片。

    说明:此参数采用multipart/form-data编码方式

  • 形式

    http://api.aibang.com/biz/{id}/pic

    例如:http://api.aibang.com/biz/971877911-703465332/pic?app_key=f41c8afccc586de03a99c86097e98ccb&uname=api_user

    参数说明
    参数 类型 是否可选 意义 备注
    id string 商户ID
    data binary 内容 图片的数据部分,字节数不大于5MB
    title string 图片标题 最多20个字符

修改商户

  • 说明

    修改商户信息。

  • 形式

    http://api.aibang.com/biz/{id}

    例如:http://openapi.aibang.com/biz/971877911-703465332?app_key=f41c8afccc586de03a99c86097e98ccb&uname=api_user

    参数说明

    以下各个参数均是可选形式

    参数 类型 是否可选 意义 备注
    name string 商户名
    status int 状态 0:正常营业;1:停业;2:暂停营业;
    tel string 电话 多个电话使用半角分号;(英文分号)分隔
    city string 城市
    county string 区县
    addr string 地址
    desc string 简介 字节数不大于50KB
    lng float 经度
    lat float 纬度
    cate string 经营类别 多个类别用半角分号;(英文分号)分隔,可能值参见商户分类表
    worktime string 营业时间
    cost int 人均消费 单位:元
    site_url string 官方网站url

添加新商户

  • 说明

    添加新商户。

  • 形式

    http://openapi.aibang.com/biz

    例如:http://openapi.aibang.com/biz?app_key=f41c8afccc586de03a99c86097e98ccb&uname=api_user

    参数说明
    参数 类型 是否可选 意义 备注
    name string 商户名
    tel string 电话 多个电话使用半角分号;(英文分号)分隔
    city string 城市
    county string 区县
    cate string 经营类别 多个类别用半角分号;(英文分号)分隔,可能值参见商户分类表
    addr string 地址
    desc string 简介 字节数不大于50KB
    lng float 经度
    lat float 纬度
    worktime string 营业时间
    cost int 人均消费 单位:元
    site_url string 官方网站url

如有问题,请发邮件至open_api#aibang.com(发邮件时请将#换为@)。

^返回顶部