Skip to content

Instantly share code, notes, and snippets.

@liwh
Created June 25, 2012 08:44
Show Gist options
  • Save liwh/2987418 to your computer and use it in GitHub Desktop.
Save liwh/2987418 to your computer and use it in GitHub Desktop.
lbs api.md

###需求

  • 根据经纬度查询附近位置的中文描述
  • 保存视频ID以及该视频经纬度,和其位置的描述
  • 根据视频ID可以查询视频的经纬度,以及所处地方的描述
  • 根据视频ID可以查询视频的经纬度,以及所处地方的描述(批量接口)
  • 根据视频ID或经纬度查询附近的视频 ###接口定义
根据视频ID或经纬度查询附近的视频
  • URL: GET , http://example.com/v1/near_videos

  • 参数定义:

    • video_id: 视频ID. 可选参数。 若lat,lng都为空。则必填。
    • lat : 纬度 , 可选参数。 若video_id为空,则必填
    • lng : 经度 , 可选参数。 若video_id为空,则必填
    • distance : 距离, 可选参数,默认为1km. 单位km
    • page: 分页号, 可选参数, 默认为第一页
    • size: 页长度,可选参数,默认为30
  • 返回结果

    • 成功
     {
       status: 'success',
       total: xxx, #记录总数
       results : [
         { video_id: 'xxxx', loc: [xx,xx] ....},
         ……
       ]
     }
    
    • 失败
    {status : "failed" , code: 400 ,desc: "..."}
    
根据经纬度查询附近位置描述接口
  • URL: GET , http://example.com/v1/get_places

  • 参数定义:

    • lat : 纬度 , 必填参数
    • lng : 经度 , 必填参数
    • radius : 距离, 可选参数,默认为500米
    • batch: 分页号, 可选参数, 默认为第一页
    • size: 页长度,可选参数,默认为20,区间在10-20之间
    • country: 地址的所属国家。可选参数,默认为zh-CN
  • 返回结果

    • 成功
     {
       status: 'success',
       total: xxx, #记录总数
       results : [
         {
           name: '优酷网office',
           address: '中钢国际大厦5层'
           distance: '100' #距离中心点的距离,若为-1,则表示未取到距离
         },
         ……
       ]
     }
    
    • 失败
    {status : "failed" , code: 400 ,desc: "..."}
    
保存视频ID以及该视频经纬度,及其位置描述接口
  • URL: POST , http://example.com/v1/video_places

  • 参数定义:

    • video_id : 视频ID, 必填参数
    • user_id: 用户ID, 必填参数
    • name : 视频位置信息地址名称,如优酷网office ,必填参数
    • address: 视频位置地址所在地, 如中钢国际广场5层, 可选参数
  • 返回结果

    • 成功
    {status: "success" , code: "1"}
    
    • 失败
    {status : "failed" , code: 400 ,desc: "..."}
    
根据视频ID查询视频的经纬度,以及地址的描述
* 返回结果参数描述
  * video_id : 视频ID
  * user_id : 用户ID
  * loc :  坐标数组,第一个代表经度longitude,第二个代表纬度latitude ,如[116.22,39.11],其中116.22代表其经度,39.11代表纬度
  * name : 地址名称
  * address : 地址详情

* 成功

```
  {
    user_id: 'xxx',
    video_id: 'xxxx',
    loc: [116.298012,39.95971],  #坐标,第一个代表经度longitude,第二个代表纬度latitude
    name: '优酷网office',
    address: '中钢国际广场'
  }
```

* 失败

```
{status : "failed" , code: 400 ,desc: "..."}
```
根据视频ID查询视频的经纬度,以及地址的描述(批量接口)
* 返回结果参数描述
  * user_id : 用户ID
  * video_id : 视频ID
  * loc :  坐标数组,第一个代表经度longitude,第二个代表纬度latitude ,如[116.22,39.11],其中116.22代表其经度,39.11代表纬度
  * name : 地址名称
  * address : 地址详情

* 成功

```
[
  {
    user_id: 'xxx',
    video_id: 'xxxx',
    loc: [116.298012,39.95971],
    name: '优酷网office',
    address: '中钢国际广场'
  },
  ...
]
```

* 失败

```
{status : "failed" , code: 400 ,desc: "..."}
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment