概述

目前我们已为第三方开发者提供位置+视频开放能力,帮助开发者快速获取设备基本信息、设备最新位置信息、设备历史轨迹、打开设备摄像头,实时查看设备视频画面、调取设备历史视频等能力。


用户登录

第三方开发者在调用各类开放能力时时,首先要通过开放平台的鉴权认证,为其分配有效的访问token后,才可授权调用其它能力接口

  • 接口名称:userlogin

  • 请求方式:POST

  • 请求参数:

字段 类型 必填 说明
mobile string true 用户名(一般为注册手机号码)
pwd string true 登录密码(须MD5加密提交)
logintype int true 登录类型,缺省填0即可
platform string false 平台类型
devicetoken string true 设备识别号,接入IP等
version string true 应用版本号,如:1.0.0.1
packname string true 包名 com.mapgoo.chedaibao
flag int false 是否返回所有设备自编号和流量卡号,1:不返回,0(缺省):返回
  • 返回参数:
字段 类型 说明
authoken string 授权token,在请求以后的接口中需要填写到请求头的Authorization属性
userid int 用户ID
username string 用户名称
objectid Array 该账号下所有设备自编号
holdid int 用户渠道号
holdname string 用户渠道名称
  • 请求示例:
curl http://192.168.100.96/v4/api/userlogin -X POST -d "
{
    "mobile": "test",
    "logintype": 0,
    "platform": "第三方",
    "packname":"com.mapgoo.chedaibao.mgkj",
    "pwd": "e10adc3949de59abbe543557f20f883e",
    "devicetoken":"",
    "version":"1.0.0",
    "flag": 1
}
"

设备信息

查询终端信息

  • 接口名称:device/getinfo
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
id string true Imei号或者设备编号
  • 返回参数:
字段 类型 说明
ObjectName string 车牌号
ObjectID string 设备ID
Imei string Imei号
ActiveTime Date 激活日期
ExpireTime Date 服务过期日期
SPeriod string 服务周期
State string 终端当前服务状态
MdtType string 终端类型
  • 请求示例:
curl http://192.168.100.96/api/device/getinfo?id=805668625060347 

设备位置

查询终端位置信息

  • 接口名称:GetSimpleObjectTracks
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
objectid string true ID号(登录时返回,或者查询终端信息得到)
flag int false 是否进行地址解析,1:解析(默认),0:不解析
  • 返回参数:
字段 类型 说明
TransType int 是否在线,0:不在线, 1:在线
gpsFlag int 当前定位标志:307/308:GPS 318:基站定位
posmode string 当前定位模式,gpsFlag的文字描述
Lon float 经度
Lat float 纬度
BDLon float 经度(百度坐标)
BDLat float 纬度(百度坐标)
Speed int 速度
Direct int 方向
RcvTime date 数据接收时间
GPSTime Date 定位时间
ObjectName string 目标名称
sim string 设备中安装的sim卡号
imei string 设备识别号
gpsLocatinAddr string 所在位置(根据Flag决定是否解析出文字描述)
DeviceState int 0:库存 1:未使用 2:已安装 3:拆机 4:报修
MDTTypeStatus int 0:有线设备 1:无线设备
State int 设备运营状态 0,1:正常 2,3:未开通 4,5:过期 6:报停 7,8:未使用
statusDes string 设备状态描述,如“待命,位置上报”
dayMileage double 当日行驶里程
mileage double 总里程
isstopState string 启动/熄火
startTime string isStopStateType=0时有效,表示启动时间(运动时长可以使用当前时间和此字段的差值计算),无效时请填写默认值:1970-01-01 08:00:00
stopTime string isStopStateType=1时有效,表示熄火时间(静止时长可以使用当前时间和此字段的差值计算),无效时请填写默认值:1970-01-01 08:00:00
  • 请求示例:
curl http://192.168.100.96/api/GetSimpleObjectTracks?objectid=123

设备轨迹

视频直播

第三方根据接口调用返回中result的值即rtmp流地址进行拉流

  • 接口名称:startlive
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
objectid int true 设备ID号(登录时返回,或者查询终端信息得到)
imei string true 设备imei号,与objectid二选一
channel int true 设备摄像头通道号,默认从0开始
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
reason string false 失败原因。只有失败时才有
result string false 直播的rtmp流地址
  • 请求示例:
curl http://192.168.100.96/api/startlive?objectid=123&channel=0

录音列表

第三方平台查询设备录音列表接口

  • 接口名称:GetRecFileList
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
seq string false 指令流水号,备用
objectID int true 设备id
startTime string true 开始时间
endTime string true 结束时间
pageNum int true 页码
pageSize int true 页大小
fileFormat string true aac格式
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
total int true 总目录条数
indexID long true 流水号
localFilePath string false 设备本地视频文件路径
fileFormat string false 文件格式
fileSize int false 文件大小,单位:kb
cloudUrl string false 云文件路径
FileModifyTime string false 文件修改时间
  • 请求示例:
curl http://192.168.100.96/api/GetRecFileList?objectID=123&startTime=2019-10-01 05:01:02&endTime=2019-10-02 15:01:02&pageNum=1&pageSize=20&fileFormat=acc

获取音频

第三方平台查询设备录音列表接口

  • 接口名称:GetRecFileUrl
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
indexID string true 记录ID
objectID int true 设备ID
seq string false 指令流水号,备用
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
reason string true 失败原因。只有失败时才有
cloudUrl string false 云文件路径

视频时间轴

第三方平台获取远程调阅拉取时间轴。备注说明:暂未实现。

  • 接口名称:getTimeLines
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
objectID int true 设备ID
sourceType int true 数据来源:1终端设备 2云端
beginTime string true 时间轴的开始时间,格式yyyy-MM-dd HH:mm:ss
endTime string true 时间轴的结束时间,格式yyyy-MM-dd HH:mm:ss
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
reason string true 失败原因。只有失败时才有
objectID int true 调阅的设备ID
imei string false 调阅的设备的IMEI
channel int true 摄像头channel编号,从0开始计算
startTime string true 视频文件的开始时间(yyyy-MM-dd HH:mm:ss)
endTime string true 视频文件的结束时间(yyyy-MM-dd HH:mm:ss)
sourceType string true 数据来源:1终端设备 2云端
  • 请求示例:
curl http://192.168.100.96/api/cloudStorage2b/getTimeLines?objectID=201576343&sourceType=1&beginTime=2019-11-2500:00:00&endTime=2019-11-25 23:59:59

发起调阅

第三方平台发起远程调阅请求。备注说明:暂未实现。

  • 接口名称:remotePlay
  • 请求方式:GET
  • 请求参数:
字段 类型 必填 说明
objectID int true 设备ID
channel int true 摄像头channel编号
beginTime string true 播放的开始时间,格式yyyy-MM-dd HH:mm:ss
sourceType string int 数据来源:1终端设备 2云端
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
reason string true 失败原因。只有失败时才有失败原因。
playId string true 远程调阅唯一编号
playUrl string true 远程调阅拉流URL地址
  • 请求示例:
curl http://192.168.100.96/api/remotePlay?objectID=201576343&channel=0&sourceType=1&beginTime=2019-11-25 10:02:26

更新设备信息

第三方更新设备信息,把设备移到指定的车牌下。备注说明:暂未实现。

  • 接口名称:vehicle/sync
  • 请求方式:POST
  • 请求参数:
字段 类型 必填 说明
imei string true 设备imei
dest_hold_name string true 设备的目标hold的名称
device_name string true 设备名称、车牌号
car_no string true 车牌号,车辆唯一识别号
contactor string true 司机姓名
contact_num string true 司机电话号码
remark string false 备注司机身份证号码
  • 返回参数:
字段 类型 必填 说明
error int true 0-成功 非0-失败
reason string true 失败原因。只有失败时才有失败原因。
  • 请求示例:
curl http://192.168.100.96/api/device/update -X POST -d "
{
    "imei": "123456789",
    "dest_hold_name":"YZ自营",
    "device_name": "赣AD1234",
    "contactor": "张三",
    "contact_num":"13813800138",
    "remark": "360122197006102014"
}
"