汽车在线页面API-使用帮助文档

一 什么是页面 API

页面API 也叫作“Page API”,或“页面集成”。
如果贵司已有自己的一套车辆用户管理系统,然后想在里面进行车辆的位置服务(比如监控,跟踪,回放),
那么您就可以使用汽车在线平台提供的页面API。
它可以让您零开发,只需调用我们的接口,就可在您的系统中拥有这些功能。

1.1 功能支持

页面API开放的功能有:监控 跟踪 回放;统计 租赁黑名单;以及微信版页面等功能

页面api

1.2 平台用户关系:

(指贵司平台 和汽车在线平台两个平台中的用户关系)
您需知道 贵司平台系统中的用户 在汽车在线平台中的对应登录用户名,
以及您系统中的设备在汽车在线平台上的IMEI号
(即您的用户和设备都是已接入汽车在线平台的,在汽车在线平台和您的系统中有对应的关系)

1.3 申请及使用简述:

申请:通过您的用户名,密码,域名,向我们申请Page API的授权码appkey。
使用:把授权码appkey放入链接中,通过链接调用我们的对应Page API功能页面。即可。

二 使用方式

1 需将url嵌入到您的系统的页面中进行调用。(直接在浏览器地址栏里访问url会报referer错误)
url形如: http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=xxx&page=monitor&target=xxx
该url会把用户带到想要去到的页面。(支持"监控"、"跟踪"、"回放"、"统计"、"租赁黑名单"、"微信版"功能)
2 调用方式形如:<iframe src="url"></iframe>
注1:该iframe必须放到您申请appkey时所提供的域名(或ip)和端口的页面里,才能访问。(其它域名的页面不行)
注2:微信版除外,微信版无需通过iframe的方式调用

三 参数说明

参数名 说明
method 固定值"jump"
appkey 您的授权码appkey,形如:dbd77ada93ca392d9f2712d6f2beb6ca
account 您申请appkey时所用的汽车在线登录账号
page 您想去到的页面。包括的值:
监控 monitor
跟踪 tracking
回放 playback
统计 report
租赁黑名单 blacklist
微信版 weixin
target 您想查看目标对象
·当为监控,统计,微信版时,对应想要查看目标用户的登录用户名
·当为"跟踪"或"回放"时(此时只能查看单个设备的),对应的是设备的IMEI号
time 当前时间(Unix时间戳,精确到秒,比如:1413772861)
·当为"微信"时,必须传递该参数;
·其它情况不用传递

工具:获取调用URL

appkey:
account:
page:
target: (请输入用户账号)
 

  请将以上代码 放入您的页面中进行访问

四 使用举例

假设您使用登录账号aaa申请了appkey:"dbd77ada93ca392d9f2712d6f2beb6ca"。

  • 1 监控(monitor)当前这个账号(即aaa)下的信息:

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=monitor&target=aaa

  • 2 监控(monitor)子用户(其登录账号为bbb)下的信息:

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=monitor&target=bbb

  • 3 跟踪(tracking)设备(其IMEI号为252411111122222)的轨迹:

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=tracking&target=252411111122222

  • 4 回放(playback)设备(其IMEI号为252411111122222)历史轨迹:

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=playback&target=252411111122222
    4.1 如需指定回放起止时间,请用参数:&from=1378018800000&to=1378026000000

  • 5 查看指定用户的统计信息(report):

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=report&target=bbb

  • 6 进入租赁黑名单功能(blacklist):

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=blacklist&target=bbb

  • 7 进入微信页面(weixin):

    http://pageapi.gpsoo.net/third?method=jump&appkey=dbd77ada93ca392d9f2712d6f2beb6ca&account=aaa&page=weixin&target=bbb&time=1413772861

五 常见问题

如果调用出错,请检查并确认:

  1. 所调用的域名 必须和申请时候填写的域名一致,包括端口。
  2. 要通过iframe嵌入调用,直接在浏览器中访问url是不行的。
  3. 请检查参数是否正确,比如"监控","统计","租赁黑名单","微信"的时候,对应的是用户
    "跟踪"和"回放"时,对应的是设备

微信功能使用说明:

  1. 访问微信公众平台(https://mp.weixin.qq.com/)进行注册,并进行相应认证。
  2. 参考公众平台开发者文档(http://mp.weixin.qq.com/wiki/index.php?title=%E9%A6%96%E9%A1%B5)-接入指南,开发相应的接口与微信进行对接。
  3. 构建认证流程。比如要求用户按照 "用户名#密码" 的格式发送消息进行账号绑定。
  4. 成功绑定账号后,根据需要设定一个特殊消息,比如"查车"。当用户发送"查车"时,在系统回复消息中加入一个页面链接A,此页面要求是申请api的域名下的页面。在获取到微信页面URL链接后加上当前时间参数-time,然后在页面A中用javascript脚本:location.href='获取的微信页面url';进行跳转。
  5. 或者你也可以在公众平台申请开启自定义菜单功能,用户点击设定的菜单时系统也回复上面的消息。