接口列表(v1)【废弃】

警告

开发者控制台新创建的应用不再支持调用v1版本接口

v1版应用请尽快在开发者控制台创建应用并升级接口调用

请先阅读接口总体规范,再阅读此文档

获取token

接口功能

该接口用于管理员账号根据appKey和secret获取accessToken。

注意

获取到的accessToken有效期是7天,请在即将过期或者接口报错11504时重新获取,请勿频繁调用,频繁调用将会被拉入限制黑名单。

请求地址

https://open.andmu.cn/v1/openapi/auth/getToken

请求方式

POST,无需鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
appKey String Y 平台分配的key
sig String Y 签名(32位小写字符串) MD5(appKey+secret)

请求内容

示例

{
    "appKey":"dfgd5115",
    "sig":"d41d8cd98f00b204e9800998ecf8427e"
}

响应参数

参数名称 参数类型 参数含义 说明
resultCode string 响应码 返回错误码。0:success
resultMsg string 响应描述 简单错误信息说明
data obj 响应数据 返回结果内容(JSON格式→ String),详情参照data数据模型

data数据模型

名称 类型 说明 备注
token String token

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "token": "1359dfsdgdf5g1s1dfg5sd.454fdg4371190.dfhg2fdg132fhgf4h165fg"
    }
}

签名方法

try{
        String appKey = "dfgd5115";
        String secret = "dgfds41d5sf1g5sdfgd";
        String sig =  Hex.encodeHexString(MessageDigest.getInstance("MD5").digest(StringUtils.getBytesUtf8(appKey+secret)));
}catch (Exception e){}

获取设备列表

接口功能

分页获取项目下设备列表。

请求地址

https://open.andmu.cn/v1/openapi/app/getDeviceList

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
page int N 页码
pageSize int N 每页大小

请求内容

示例

{
    "page": 1,
    "pageSize": 10
}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
total Integer 记录数 分页查询时使用
page Integer 当前页 分页查询时使用
pageSize Integer 页大小 分页查询时使用
data List 响应数据 响应数据,支持分页和不分页两种方式

data数据模型

名称 类型 说明 备注
deviceId String 设备id
deviceName String 设备名 目前暂为空

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "total": 100,
    "page": 1,
    "pageSize": 2,
    "data": [
        {
            "deviceId":"xxxxS_de16b0"
        },
        {
            "deviceId":"xxxxS_de16b0"
        }
    ]
}

获取绑定参数

接口功能

获取绑定参数,去调用appSDK绑定摄像头接口用。

请求地址

https://open.andmu.cn/v1/openapi/app/getDeviceBindParam

请求方式

POST,需要鉴权

请求参数

请求内容

示例

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data List 响应数据 响应数据,支持分页和不分页两种方式

data数据模型

名称 类型 说明 备注
storeId String 企业ID
shortToken String 视频能力相关
username String 视频能力相关
unifiedId String 视频能力相关
token String 交互token

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "storeId":"xxxxS_de16b0",
        "shortToken":"df215152",
        "username":"ddfds",
        "token":"fsdfsdf15ds1f5sgsdfgdsfg",
        "unifiedId":""df415132"
    }
}

获取设备视频播放WebSDK链接

接口功能

获取设备视频播放WebSDK链接,调用WebSDK播放视频。

请求地址

https://open.andmu.cn/v1/openapi/app/getLiveUrl

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
deviceId String Y 设备ID

请求内容

示例

{"deviceId":"xxxxS_de16b0"}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data object 响应数据

data数据模型

名称 类型 说明 备注
url String 拉取直播流的url

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "url":"https://open.andmu.cn?...&......."
    }
}

获取设备纯视频播放WebSDK链接

接口功能

获取设备纯视频播放WebSDK链接,可以组合成多屏播放。

请求地址

https://open.andmu.cn/v1/openapi/app/getMultiScreenLiveUrl

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
deviceId String Y 设备ID

请求内容

示例

{"deviceId":"xxxxS_de16b0"}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data object 响应数据

data数据模型

名称 类型 说明 备注
url String 拉取纯直播流的url

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "url":"https://open.andmu.cn?...&......."
    }
}

获取设备视频播放参数(APP SDK)

接口功能

根据deviceid获取设备视频播放参数(APP SDK),使用APP SDK能力播放视频。

请求地址

https://open.andmu.cn/v1/openapi/app/getVideoLiveParam

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
deviceId String Y 设备ID

请求内容

示例

{"deviceId":"xxxxS_de16b0"}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data List 响应数据 响应数据,支持分页和不分页两种方式

data数据模型

名称 类型 说明 备注
deviceId String 设备ID
storeId String 店铺ID
token String 视频能力相关
videoPrivs String 播放权限
unifiedId String 视频能力相关

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "deviceId":"xxxxS_de16b0",
        "token":"dfsfsd15d34g1d5s2gfvs5dgf",
        "videoPrivs":"#camera_common_relay#camera_common_playback",
        "unifiedId":"sadfajsdgg4d5sfg1sdfa15sfas",
        "storeId":"15121"
    }
}

获取解绑参数

接口功能

根据deviceid获取解绑参数,调用appSDK解绑接口去解绑摄像头。

请求地址

https://open.andmu.cn/v1/openapi/app/getDeviceUnbindParam

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
deviceId String Y 设备ID

请求内容

示例

{"deviceId":"xxxxS_de16b0"}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data List 响应数据 响应数据,支持分页和不分页两种方式

data数据模型

名称 类型 说明 备注
deviceId String 设备ID
token String 视频能力相关

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data": {
        "deviceId":"xxxxS_de16b0",
        "token":"sf5ef1aw3e4f5aw32f0asd"
    }
}

获取实时缩略图

接口功能

根据deviceid获取该设备的实时缩略图。

请求地址

https://open.andmu.cn/v1/openapi/app/realtime/thumbnail

请求方式

POST,需要鉴权

请求参数

参数名称 参数类型 是否必需 参数含义 说明
deviceId String Y 设备ID

请求内容

示例

{"deviceId":"xxxxS_de16b0"}

响应参数

参数名称 参数类型 参数含义 说明
resultCode String 响应码 参考响应码定义
resultMsg String 响应描述
data String 响应数据 响应数据,实时缩略图地址

返回数据示例

{
    "resultCode": "000000",
    "resultMsg": "成功",
    "data":"http://openapi.h.reservehemu.com/rest/service/camera/xxxxS_0011224b9124/thumbnail/current?size=320x320&token=9efcc1a1c5af401e8336"
}