NAV undefined
undefined

开始前必读

更新日志

签名规则

签名示例:

/*
 * POST https://api.camsgear.com/v1/applications/bind
 * body:
 * {
 *  "alias": "outuserid",
 *  "userId": "5a211d4c6f76ee667b8e309d",
 *  "serialNumber": "testserialnumber"
 * }
 */

const crypto = require('crypto')
const queryString = require('querystring')
const MD5 = crypto.createHash('md5')

const sortObjectByKey = (rawObject) => {
  let sortedObject = {}
  Object.keys(rawObject).sort().forEach(function (key, value) {
    sortedObject[key] = rawObject[key]
  })
  return sortedObject
}

// 获取到的app秘钥, 为了确保加密的安全性, 建议在后台进行签名加密以免暴露签名秘钥
const appSecret = 'A0aXORJQ1TYn05iB0kznKysl1AHKvhpI'
// 将Body中参与签名的参数进行排序
const params = sortObjectByKey({
  alias: 'outuserid',
  userId: '5a211d4c6f76ee667b8e309d',
  serialNumber: 'testserialnumber'
})

// 将参数进行拼接;注意不要进行URL转码
let stringA = queryString.stringify(params, '&', '=', { encodeURIComponent: uri => uri })
console.log(stringA)
// 输出 alias=outuserid&serialNumber=testserialnumber&userId=5a211d4c6f76ee667b8e309d

// 在最后拼接加密秘钥
let stringB = `${stringA}&appSecret=${appSecret}`
console.log(stringB)
// 输出 alias=outuserid&serialNumber=testserialnumber&userId=5a211d4c6f76ee667b8e309d&appSecret=A0aXORJQ1TYn05iB0kznKysl1AHKvhpI

// 对拼接字符串进行MD5加密
let sign = MD5.update(stringB).digest('hex')
console.log(sign)
// 输出 d08aa1f89c166210818019fb197c5cbf

通用签名步骤

  1. 将所有发送或接受到的数据进行排序拼接,生成StringA
  2. 将appSecret放在StringA最后进行拼接(参数名为appSecret),生成StringB
  3. 将StringB进行MD5加密,放在请求Headers的signature中

签名规则

  1. 若为POST请求, 则Body中的参数参与签名;若为GET请求, 则Query Params中的参数参与签名;URL Params中的参数不参与签名;
  2. 参数名ASCII码从小到大排序(字典序)
  3. 如果参数的值为空, 则不参与签名
  4. 参数名区分大小写
  5. 若为GET请求, 参加拼接的参数不进行URL转码

应用(Application)模块

用户/设备绑定

接入方可以通过此接口将接入方自身用户、设备与内部的用户进行关联与绑定

HTTP Request

POST https://api.camsgear.com/v1/applications/bind

示例:

请求示例:
Method: POST
URL: https://api.camsgear.com/v1/applications/bind
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '0a2041a301c7bb1ccf5858a6e318eca4' }
]
body:
{
 "alias": "outuserid",
 "serialNumber": "testserialnumber"
}

返回值示例: 
{
  authorization": "FCCrWRokXABPmfwWR4QKwlt2eE3o4nbA1blG1gpHwbWQ0GPUplaG2d3hVXqPtsePNUOMTHD2IjwhoWwTNW7SFIDh8pIMw55DrImJW2jYnMAuM0MzlM1f3q3bOsVsf76zfZ54CVVQg9OSU7yAFgEinKiH40UoWCtXE5VOOgpQe7irnIm4lIeVIhmoWofZaluH8DThJDQdMDXyBBXvz8DNgL1DG9WMSRTDHJ57YVGnTsNvww95"
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Body

字段名 变量名 必填 类型 示例值 描述
别名ID alias String 5a28c0089b3ff3 接入方用户ID或标识
设备序列号 serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备

Response

字段名 变量名 必填 类型 示例值 描述
访问凭证 authorization | String 绑定用户的访问凭证

用户/设备解绑

接入方可以通过此接口将接入方自身用户与设备进行解绑

HTTP Request

POST https://api.camsgear.com/v1/applications/unbind

示例:

请求示例:
Method: POST
URL: https://api.camsgear.com/v1/applications/unbind
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '0a2041a301c7bb1ccf5858a6e318eca4' }
]
body:
{
 "alias": "outuserid",
 "serialNumber": "testserialnumber"
}

返回值示例: 
{
  "success": true
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Body

字段名 变量名 必填 类型 示例值 描述
别名ID alias String 5a28c0089b3ff3 接入方用户ID或标识
设备序列号 serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备

Response

字段名 变量名 必填 类型 示例值 描述
解绑结果 success | Boolean 是否解绑成功

设备重置

接入方可以通过此接口清空设备数据
该接口会清除当前App下所有与该设备相关的数据,包括用户绑定关系、图片流数据。

清除的数据无法恢复!!请谨慎调用!

HTTP Request

POST https://api.camsgear.com/v1/applications/reset

示例:

请求示例:
Method: POST
URL: https://api.camsgear.com/v1/applications/reset
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '9079d3c9915c501965c988a6f3242d19' }
]
body:
{
 "serialNumber": "testserialnumber"
}

返回值示例: 
{
  "success": true
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Body

字段名 变量名 必填 类型 示例值 描述
设备序列号 serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备

Response

字段名 变量名 必填 类型 示例值 描述
重置结果 success | Boolean 是否重置成功

获取设备列表

获取当前应用下所有设备列表

HTTP Request

GET https://api.camsgear.com/v1/applications/devices

示例:

请求示例:
Method: GET
URL: https://api.camsgear.com/v1/applications/devices
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '0a2041a301c7bb1ccf5858a6e318eca4' }
]

返回值示例: 
{
    "total": 1,
    "skip": 0,
    "data":[
        {
            "serialNumber": "PDS11Q79K0047",
            "isOnline": true,
            "ip": "192.168.1.100"
        }
    ]
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Response

字段名 变量名 必填 类型 示例值 描述
总记录条数 total | Int 10 所有记录条数
跳过的记录条数 skip | Int 0 跳过的记录条数
设备列表 data | Array 设备列表
设备序列号 data.$.serialNumber | String PDS11Q79K0047 设备序列号
是否在线 data.$.isOnline | Boolean true 设备是否在线状态
设备ip data.$.ip | String 192.168.1.100 设备ip

获取设备图片流日期列表

获取指定设备日期列表, 可以返回指定日期、指定小时、指定时区的数据;若某个小时或某一天没有数据,则不返回对应的列表

HTTP Request

GET https://api.camsgear.com/v1/applications/imagecams/days

示例1:

请求示例: 默认获取七天的数据列表
Method: GET
URL: https://api.camsgear.com/v1/applications/imagecams/days?serialNumber=PDS11Q79K0047

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '139a2331c89bacf5fcd39168ed847510' }
]

返回值示例:
{
    "total": 30,
    "skip": 0,
    "data":[
        {
            "day": "2017-09-30",
            "hours":[
                {"hour": "00"},
                {"hour": "01"},
                {"hour": "02"},
                {"hour": "03"},
                {"hour": "04"},
                {"hour": "05"},
                {"hour": "06"},
                {"hour": "07"},
                {"hour": "08"},
                {"hour": "09"},
                {"hour": "10"},
                {"hour": "11"},
                {"hour": "12"},
                {"hour": "13"},
                {"hour": "14"},
                {"hour": "15"},
                {"hour": "16"},
                {"hour": "17"},
                {"hour": "18"},
                {"hour": "19"},
                {"hour": "20"},
                {"hour": "21"},
                {"hour": "22"},
                {"hour": "23"}
            ]
        },
        {
            "day": "2017-09-29",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-28",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-27",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-26",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-25",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-24",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        }
    ]
}

示例2:

请求示例: 获取指定日期,指定小时的数据列表
Method: GET
URL: https://api.camsgear.com/v1/applications/imagecams/days?hours=05,21,22&day=2017-09-28&serialNumber=PDS11Q79K0047
headers: 略

返回值示例: (若没有22小时的数据,则不返回对应小时数)
{
    "total": 1,
    "skip": 0,
    "data":[
        {
        "day": "2017-09-28",
        "hours": [
                {"hour": "05"},
                {"hour": "21"}
            ]
        }
    ]
}

若不指定日期只指定小时数,则返回7天对应的小时数列表

示例3:

请求示例: 获取指定范围日期列表与记录条数限制
Method: GET
URL: https://api.camsgear.com/v1/applications/imagecams/days?day[$lt]=2017-09-24&$limit=3&serialNumber=PDS11Q79K0047
headers: 略

返回值示例:(返回日期小于2017-09-243条记录)
{
    "total": 23,
    "limit": 3,
    "skip": 0,
    "data":[
        {
            "day": "2017-09-23",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-22",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-21",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        }
    ]
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Query Parameters

字段名 变量名 必填 类型 示例值 描述
设备序列号 serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备

Response

字段名 变量名 必填 类型 示例值 描述
总记录条数 total | Int 10 所有记录条数
跳过的记录条数 skip | Int 0 跳过的记录条数
图片流列表 data | Array 图片流列表
日期 data.$.day | String 2017-09-20 日期(年月日)
小时列表 data.$.hours | Array 返回小时数(00-23)
具体小时数 data.$.hours.$.hour | String 01 小时数(若当前小时无数据,则不返回)

获取设备图片流数据列表

获取指定日期图片流图片地址信息

HTTP Request

GET https://api.camsgear.com/v1/applications/imagecams/data

示例:

请求示例:
Method: GET
URL: https://api.camsgear.com/v1/applications/imagecams/data?day=2017-09-02&hours=05&serialNumber=PDS11Q79K0047
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '139a2331c89bacf5fcd39168ed847510' }
]

返回值示例:
{
    "day": "2017-09-02",
    "hours":[
        {
            "hour": "05",
            "resources":[
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299660000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299720000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299780000.jpg",
                    "timestamp": "1504299600000"
                },
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299840000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299900000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299960000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300020000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300080000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300140000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300200000.jpg", "timestamp": "1504299600000"…}
            ]
        }
    ],
    "mediaInfo":{
        "count": 1,
        "mount": 0,
        "width": 1088,
        "projection": 0,
        "fov": 210,
        "height": 1088,
        "needStitch": true,
        "orientation": 0,
        "order": 1
    },
    "calibration": "version=v1&data=0.5,0.5,0.416360294,1.832595712&type=0"
}

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
签名 signature String(32) 通过签名算法计算得出的签名值, 详见签名生成算法

Query Parameters

字段名 变量名 必填 类型 示例值 描述
设备序列号 serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备
指定的日期 day String 2017-09-21 获取指定日期的数据列表
指定的小时数 hours String 05,21,22 获取指定小时列表(逗号分隔),若指定小时无数据则不返回
时区 timezone String +0800 获取对应时区的日期列表,默认+0800;若修改时区,第一次请求会较慢

Response

字段名 变量名 必填 类型 示例值 描述
日期 $.day | String 2017-09-20 日期(年月日)
小时列表 $.hours | Array 返回小时数(00-23)
具体小时数 $.hours.$.hour | String 01 小时数(若当前小时无数据,则不返回)
图片地址列表 $.hours.$.resources | Array 图片的路径
图片地址路径 $.hours.$.resources.$.path |String http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg 访问路径
图片时间戳 $.hours.$.resources.$.timestamp | String(13) 1504299600000 截取图片的UTC时间戳(12位,精确到毫秒)
图像信息 data.$.mediaInfo | Object | 图像信息
| data.$.mediaInfo.count | Int 1 一帧中单幅画面的数量
| data.$.mediaInfo.mount | Int 0 一帧中单幅画面的挂载方式
| data.$.mediaInfo.width | Int 1080 一帧中单幅画面的宽
| data.$.mediaInfo.height | Int 1080 一帧中单幅画面的高
| data.$.mediaInfo.projection | Int 0 一帧中单幅画面的投影类型
| data.$.mediaInfo.fov | Int 210 一帧中单幅画面的FOV(度)
| data.$.mediaInfo.needStitch | Boolean true 是否需要拼接
| data.$.mediaInfo.orientation | Int 0 一帧中单幅画面的旋转角度(度)
| data.$.mediaInfo.order | Int 1 一帧中画面的排列顺序
拼接参数 data.$.calibration | String 相机拼接参数

图片流(ImageCam)模块

图片流列表

获取用户下创建的图片流列表

示例:

请求示例:
Method: GET
URL: https://api.camsgear.com/v1/imagecams
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

返回值示例: 
{
    "total": 2,
    "skip": 0,
    "data":[
        {
            "id": "5a28e437105d00b4ff3b7682",
            "serialNumber": "PDS11Q79K0047",
            "mediaInfo": {
                "count": 1,
                "mount": 0,
                "width": 1088,
                "projection": 0,
                "fov": 210,
                "height": 1088,
                "needStitch": true,
                "orientation": 0,
                "order": 1
            },
            "calibration": "version=v1&data=0.5,0.5,0.416360294,1.832595712&type=0...",
            "appID": "lP0Zn8Dc1Xu6inDx"
        },
        {"id": "5a28e53b105d00b4ff3b7683", "serialNumber": "testcase2", "mediaInfo":{"count": 1,…}
    ]
}

HTTP Request

GET https://api.camsgear.com/v1/imagecams

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
访问凭证 authorization String 绑定用户时获取的凭证

Response

字段名 变量名 必填 类型 示例值 描述
总记录条数 total | Int 10 所有记录条数
跳过的记录条数 skip | Int 0 跳过的记录条数
图片流列表 data | Array 图片流列表
图片流ID data.$.id | String 5a28e437105d00b4ff3b7682 唯一标识一个图片流
设备序列号 data.$.serialNumber | String PDS11Q79K0047 设备序列号,唯一标识一台设备
图像信息 data.$.mediaInfo | Object | 图像信息
| data.$.mediaInfo.count | Int 1 一帧中单幅画面的数量
| data.$.mediaInfo.mount | Int 0 一帧中单幅画面的挂载方式
| data.$.mediaInfo.width | Int 1080 一帧中单幅画面的宽
| data.$.mediaInfo.height | Int 1080 一帧中单幅画面的高
| data.$.mediaInfo.projection | Int 0 一帧中单幅画面的投影类型
| data.$.mediaInfo.fov | Int 210 一帧中单幅画面的FOV(度)
| data.$.mediaInfo.needStitch | Boolean true 是否需要拼接
| data.$.mediaInfo.orientation | Int 0 一帧中单幅画面的旋转角度(度)
| data.$.mediaInfo.order | Int 1 一帧中画面的排列顺序
拼接参数 data.$.calibration | String 相机拼接参数

图片流详情

通过图片流ID获取图片流详情

示例:

请求示例:(同时支持通过图片流ID或设备号查询)
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

返回值示例:     
{
    "id": "5a28e437105d00b4ff3b7682",
    "serialNumber": "PDS11Q79K0047",
    "mediaInfo": {
        "count": 1,
        "mount": 0,
        "width": 1088,
        "projection": 0,
        "fov": 210,
        "height": 1088,
        "needStitch": true,
        "orientation": 0,
        "order": 1
    },
    "calibration": "version=v1&data=0.5,0.5,0.416360294,1.832595712&type=0..."
}

HTTP Request

GET https://api.camsgear.com/v1/imagecams/:id

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
访问凭证 authorization String 绑定用户时获取的凭证

URL Parameters

字段名 变量名 必填 类型 示例值 描述
图片流标识id id String PDS11Q79K0047 设备号或者图片流ID

Response

字段名 变量名 必填 类型 示例值 描述
ID id | String 5a28e437105d00b4ff3b7682 唯一标识一个图片流
设备序列号 serialNumber | String PDS11Q79K0047 设备序列号,唯一标识一台设备
图像信息 mediaInfo | Object | 图像信息
| mediaInfo.count | Int 1 一帧中单幅画面的数量
| mediaInfo.mount | Int 0 一帧中单幅画面的挂载方式
| mediaInfo.width | Int 1080 一帧中单幅画面的宽
| mediaInfo.height | Int 1080 一帧中单幅画面的高
| mediaInfo.projection | Int 0 一帧中单幅画面的投影类型
| mediaInfo.fov | Int 210 一帧中单幅画面的FOV(度)
| mediaInfo.needStitch | Boolean true 是否需要拼接
| mediaInfo.orientation | Int 0 一帧中单幅画面的旋转角度(度)
| mediaInfo.order | Int 1 一帧中画面的排列顺序
拼接参数 calibration | String 相机拼接参数

图片流日期列表

获取指定图片流下的日期列表, 可以返回指定日期、指定小时、指定时区的数据;若某个小时或某一天没有数据,则不返回对应的列表

示例1:

请求示例: 默认获取七天的数据列表
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days 
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

返回值示例:
{
    "total": 30,
    "skip": 0,
    "data":[
        {
            "day": "2017-09-30",
            "hours":[
                {"hour": "00"},
                {"hour": "01"},
                {"hour": "02"},
                {"hour": "03"},
                {"hour": "04"},
                {"hour": "05"},
                {"hour": "06"},
                {"hour": "07"},
                {"hour": "08"},
                {"hour": "09"},
                {"hour": "10"},
                {"hour": "11"},
                {"hour": "12"},
                {"hour": "13"},
                {"hour": "14"},
                {"hour": "15"},
                {"hour": "16"},
                {"hour": "17"},
                {"hour": "18"},
                {"hour": "19"},
                {"hour": "20"},
                {"hour": "21"},
                {"hour": "22"},
                {"hour": "23"}
            ]
        },
        {
            "day": "2017-09-29",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-28",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-27",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-26",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-25",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-24",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        }
    ]
}

示例2:

请求示例: 获取指定日期,指定小时的数据列表
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days?hours=05,21,22&day=2017-09-28
headers: 略

返回值示例: (若没有22小时的数据,则不返回对应小时数)
{
    "total": 1,
    "skip": 0,
    "data":[
        {
        "day": "2017-09-28",
        "hours": [
                {"hour": "05"},
                {"hour": "21"}
            ]
        }
    ]
}

若不指定日期只指定小时数,则返回7天对应的小时数列表

示例3:

请求示例: 获取指定范围日期列表与记录条数限制
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days?day[$lt]=2017-09-24&$limit=3
headers: 略

返回值示例:(返回日期小于2017-09-243条记录)
{
    "total": 23,
    "limit": 3,
    "skip": 0,
    "data":[
        {
            "day": "2017-09-23",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-22",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        },
        {
            "day": "2017-09-21",
            "hours":[{"hour": "00" }, {"hour": "01" }, {"hour": "02"…]
        }
    ]
}

HTTP Request

GET https://api.camsgear.com/v1/imagecams/:id/days

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID
访问凭证 authorization String 获取到的凭证

URL Parameters

字段名 变量名 必填 类型 示例值 描述
图片流标识id id String PDS11Q79K0047 设备号或者图片流ID

Query Parameters

字段名 变量名 必填 类型 示例值 描述
指定的日期 day String 2017-09-21 获取指定日期的数据列表
指定的小时数 hours String 05,21,22 获取指定小时列表(逗号分隔),若指定小时无数据则不返回
时区 timezone String +0800 获取对应时区的日期列表,默认+0800;若修改时区,第一次请求会较慢
记录条数限制 $limit Number 4 指定返回记录条数,默认7,最大7

Response

字段名 变量名 必填 类型 示例值 描述
总记录条数 total | Int 10 所有记录条数
跳过记录条数 skip | Int 0 分页跳过的条数
日期列表数组 data | Array 日期列表
日期 data.$.day | String 2017-09-20 日期(年月日)
小时列表 data.$.hours | Array 返回小时数(00-23)
具体小时数 data.$.hours.$.hour | String 01 小时数(若当前小时无数据,则不返回)

图片流数据列表

获取指定日期图片流图片地址信息

注:查询参数与获取图片流日期列表类似,由于返回数据量巨大,日期必须指定,只返回特定日期图片地址列表

示例1:

请求示例:
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/data?day=2017-09-02&hours=05 
headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

返回值示例:
{
    "day": "2017-09-02",
    "hours":[
        {
            "hour": "05",
            "resources":[
                "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg",
                "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299660000.jpg",
                "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299720000.jpg",
                "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299780000.jpg",
                "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299840000.jpg",
                ...
            ]
        }
    ],
    "mediaInfo":{
        "count": 1,
        "mount": 0,
        "width": 1088,
        "projection": 0,
        "fov": 210,
        "height": 1088,
        "needStitch": true,
        "orientation": 0,
        "order": 1
    },
    "calibration": "version=v1&data=0.5,0.5,0.416360294,1.832595712&type=0"
}

示例2:

请求示例: 添加needTimestamp参数后的返回值
Method: GET
URL: https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/data?day=2017-09-02&hours=05&needTimestamp=true
headers: 略

返回值示例:
{
    "day": "2017-09-02",
    "hours":[
        {
            "hour": "05",
            "resources":[
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299660000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299720000.jpg",
                    "timestamp": "1504299600000"
                },
                {
                    "path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299780000.jpg",
                    "timestamp": "1504299600000"
                },
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299840000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299900000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299960000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300020000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300080000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300140000.jpg", "timestamp": "1504299600000"…},
                {"path": "http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504300200000.jpg", "timestamp": "1504299600000"…}
            ]
        }
    ],
    "mediaInfo":{
        "count": 1,
        "mount": 0,
        "width": 1088,
        "projection": 0,
        "fov": 210,
        "height": 1088,
        "needStitch": true,
        "orientation": 0,
        "order": 1
    },
    "calibration": "version=v1&data=0.5,0.5,0.416360294,1.832595712&type=0"
}

HTTP Request

GET https://api.camsgear.com/v1/imagecams/:id/data

Headers

字段名 变量名 必填 类型 示例值 描述
应用ID appid String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用
访问凭证 authorization String 绑定用户时获取的凭证

URL Parameters

字段名 变量名 必填 类型 示例值 描述
图片流标识id id String PDS11Q79K0047 设备号或者图片流ID

Query Parameters

字段名 变量名 必填 类型 示例值 描述
指定的日期 day String 2017-09-21 获取指定日期的数据列表
指定的小时数 hours String 05,21,22 获取指定小时列表(逗号分隔),若指定小时无数据则不返回
时区 timezone String +0800 获取对应时区的日期列表,默认+0800;若修改时区,第一次请求会较慢
是否需要时间戳(utc) needTimestamp Boolean true 扩展模式,返回图片流的数据时返回图片时间戳,默认false

Response

字段名 变量名 必填 类型 示例值 描述
日期 $.day | String 2017-09-20 日期(年月日)
小时列表 $.hours | Array 返回小时数(00-23)
具体小时数 $.hours.$.hour | String 01 小时数(若当前小时无数据,则不返回)
图片地址列表 $.hours.$.resources | Array 图片的路径
图片地址路径 $.hours.$.resources.$.path |String http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg 访问路径
图片时间戳 $.hours.$.resources.$.timestamp | String(13) 1504299600000 截取图片的UTC时间戳(12位,精确到毫秒)
图像信息 data.$.mediaInfo | Object | 图像信息
| data.$.mediaInfo.count | Int 1 一帧中单幅画面的数量
| data.$.mediaInfo.mount | Int 0 一帧中单幅画面的挂载方式
| data.$.mediaInfo.width | Int 1080 一帧中单幅画面的宽
| data.$.mediaInfo.height | Int 1080 一帧中单幅画面的高
| data.$.mediaInfo.projection | Int 0 一帧中单幅画面的投影类型
| data.$.mediaInfo.fov | Int 210 一帧中单幅画面的FOV(度)
| data.$.mediaInfo.needStitch | Boolean true 是否需要拼接
| data.$.mediaInfo.orientation | Int 0 一帧中单幅画面的旋转角度(度)
| data.$.mediaInfo.order | Int 1 一帧中画面的排列顺序
拼接参数 data.$.calibration | String 相机拼接参数

热区分析配置 (Heatmap Config) 模块

创建热区

创建Heatmap

HTTP Request

POST https://api.camsgear.com/developer/heatmaps

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID
访问凭证   authorization 是   String 略   获取到的凭证

Body

字段名 变量名 必填  类型  示例值 描述 
热区图名称  name 是   String 乐贝家 热区图名称 
设备列表   devices 否   Array 略   候选设备列表

Response

字段名 变量名 类型  示例值 描述 
热区ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个热区 
热区名称   name String 乐贝家 热区名称  
场景列表   scenes Array 略   一个热区包含的场景列表 
场景名称   scenes.$.name String 乐贝家全店  场景名称  
场景底图列表 scenes.$.bases Array 略   场景底图列表
场景底图名称 scenes.$.bases.$.name String 实景图/线框图 场景底图  
场景底图地址 scenes.$.bases.$.source String http://xxxx.jpg 场景底图地址
场景底图类型 data.$.scenes.$.bases.$.type String heatmap,origin,custom 底图类型  
设备列表   scenes.$.devices Array 略   场景包含的设备列表
设备列表   scenes.$.devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

获取热区列表

获取用户下创建的热区列表

HTTP Request

GET https://api.camsgear.com/developer/heatmaps

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热区列表   data Array 略   热区列表  
热区ID  data.$.id String 5a28e437105d00b4ff3b7682 唯一标识一个热区 
热区名称   data.$.name String 乐贝家 热区名称  
场景列表   data.$.scenes Array 略   一个热区包含的场景列表 
场景名称   data.$.scenes.$.name String 乐贝家全店  场景名称  
场景底图列表 data.$.scenes.$.bases Array 略   场景底图列表
场景底图名称 data.$.scenes.$.bases.$.name String 实景图/线框图 场景底图  
场景底图地址 data.$.scenes.$.bases.$.source String http://xxxx.jpg 场景底图地址
场景底图类型 data.$.scenes.$.bases.$.type String heatmap,origin,custom 底图类型  
设备列表   data.$.scenes.$.devices Array 略   场景包含的设备列表
设备列表   data.$.scenes.$.devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

获取单个热区详情

通过热区ID获取热区详情

HTTP Request

GET https://api.camsgear.com/developer/heatmaps/:heatmapId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 

Response

字段名 变量名 类型  示例值 描述 
热区ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个热区 
热区名称   name String 乐贝家 热区名称  
场景列表   scenes Array 略   一个热区包含的场景列表 
场景名称   scenes.$.name String 乐贝家全店  场景名称  
场景底图列表 scenes.$.bases Array 略   场景底图列表
场景底图名称 scenes.$.bases.$.name String 实景图/线框图 场景底图  
场景底图地址 scenes.$.bases.$.source String http://xxxx.jpg 场景底图地址
场景底图类型 scenes.$.bases.$.type String heatmap,origin,custom 底图类型  
设备列表   scenes.$.devices Array 略   场景包含的设备列表
设备列表   scenes.$.devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

删除热区

根据热区ID删除热区,

HTTP Request

DELETE https://api.camsgear.com/developer/heatmaps/:heatmapId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID
访问凭证   authorization 是   String 略   获取到的凭证

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
热区Id  heatmapId 是   String 略   待删除的热区Id

Response

字段名 变量名 类型  示例值 描述 
是否删除成功 success Boolean true 是否删除成功

创建热区场景

根据热区ID创建热区场景

HTTP Request

POST https://api.camsgear.com/developer/heatmaps/:heatmapId/scenes

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 

Body

字段名 变量名 必填  类型  示例值 描述 
场景名称   name 否   String 乐贝家 场景名称  
设备列表   devices 是   Array 略   需要添加到场景中的设备serialNumber 

Response

字段名 变量名 类型  示例值 描述 
场景ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个热区场景  
场景名称   name String 乐贝家全店  场景名称  
场景底图列表 bases Array 略   场景底图列表
场景底图名称 bases.$.name String 实景图/线框图 场景底图  
场景底图地址 bases.$.source String http://xxxx.jpg 场景底图地址
场景底图类型 bases.$.type String heatmap,origin,custom 底图类型  
设备列表   devices Array 略   场景包含的设备列表
设备列表   devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

获取热区场景

根据热区场景ID获取场景

HTTP Request

GET https://api.camsgear.com/developer/heatmaps/:heatmapId/scenes/:sceneId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 
场景id  sceneId 是   String 略   场景ID 

Response

字段名 变量名 类型  示例值 描述 
场景ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个热区场景  
场景名称   name String 乐贝家全店  场景名称  
场景底图列表 bases Array 略   场景底图列表
场景底图名称 bases.$.name String 实景图/线框图 场景底图  
场景底图地址 bases.$.source String http://xxxx.jpg 场景底图地址
场景底图类型 bases.$.type String heatmap,origin,custom 底图类型  
设备列表   devices Array 略   场景包含的设备列表
设备列表   devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

上传场景底图 - URL

以URL方式上传底图

HTTP Request

POST https://api.camsgear.com/developer/heatmaps/:heatmapId/scenes/:sceneId/bases

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 
场景id  sceneId 是   String 略   场景ID 

Body

字段名 变量名 必填  类型  示例值 描述 
名称  name 否   String 略   底图名称  
类型  type 否   String custom 底图类型  
地址  source 否   URL 略   底图源

Response

字段名 变量名 类型  示例值 描述 
场景底图名称 name String 实景图/线框图 场景底图  
场景底图地址 source String http://xxxx.jpg 场景底图地址
场景底图类型 type String heatmap,origin,custom 底图类型  

获取场景底图

HTTP Request

GET https://api.camsgear.com/developer/heatmaps/:heatmapId/scenes/:sceneId/bases/:baseType

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 
场景id  sceneId 是   String 略   场景ID 
底图类型   sceneType 是   String all,origin,heatmap,custom 底图类型  

Response

字段名 变量名 类型  示例值 描述 
场景底图名称 name String 实景图/线框图 场景底图  
场景底图地址 source String http://xxxx.jpg 场景底图地址
场景底图类型 type String heatmap,origin,custom 底图类型  

创建场景ROI

创建场景中感兴趣 - 需要独立计算热区数值的区域

HTTP Request

POST https://api.camsgear.com/v1/scenes/:sceneId/roi

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
场景id  sceneId 是   String 略   场景ID 

Body

字段名 变量名 必填  类型  示例值 描述 
名称  name 是   String 略   ROI名称 
起始点坐标: x  x 是   Float 略   起始点坐标: x 一般化后的值 
起始点坐标: y  y 是   Float 略   起始点坐标: y 一般化后的值 
区域宽: width width 是   Float 略   区域宽: width 一般化后的值
区域长: height height 是   Float 略   区域长: height 一般化后的值

Response

字段名 变量名 类型  示例值 描述 
ROI id id String 5a28e437105d00b4ff3b7682 唯一标识一个ROI
所在场景ID   sceneId String 5a28e437105d00b4ff3b7683 唯一标识一个场景 
原始区域坐标 origin Object 略   区域坐标  
原始区域坐标 x origin.x Float 略   区域坐标 x  
原始区域坐标 y origin.y Float 略   区域坐标 y  
原始区域坐标 width origin.width Float 略   区域坐标 width  
原始区域坐标 height origin.height Float 略   区域坐标 height  

获取场景ROI

获取场景中感兴趣 - 需要独立计算热区数值的区域

HTTP Request

GET https://api.camsgear.com/v1/scenes/:sceneId/rois

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
场景id  sceneId 是   String 略   场景ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热区列表   data Array 略   热区列表  
ROI id data.$id String 5a28e437105d00b4ff3b7682 唯一标识一个ROI
所在场景ID   data.$.sceneId String 5a28e437105d00b4ff3b7683 唯一标识一个场景 
原始区域坐标 data.$.origin Object 略   区域坐标  
原始区域坐标 x data.$.origin.x Float 略   区域坐标 x  
原始区域坐标 y data.$.origin.y Float 略   区域坐标 y  
原始区域坐标 width data.$.origin.width Float 略   区域坐标 width  
原始区域坐标 height data.$.origin.height Float 略   区域坐标 height  

删除场景ROI

删除场景中感兴趣 - 需要独立计算热区数值的区域

HTTP Request

DELETE https://api.camsgear.com/v1/rois/:roiid

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
ROI id roiid 是   String 略   ROI ID

Response

字段名 变量名 类型  示例值 描述 
是否删除成功 success Boolean true 是否删除成功

创建场景 EROI

创建场景中需要在计算中剔除的区域

HTTP Request

POST https://api.camsgear.com/v1/scenes/:sceneId/EROI

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
场景id  sceneId 是   String 略   场景ID 

Body

字段名 变量名 必填  类型  示例值 描述 
名称  name 是   String 略   EROI名称 
起始点坐标: x  x 是   Float 略   起始点坐标: x 一般化后的值 
起始点坐标: y  y 是   Float 略   起始点坐标: y 一般化后的值 
区域宽: width width 是   Float 略   区域宽: width 一般化后的值
区域长: height height 是   Float 略   区域长: height 一般化后的值

Response

字段名 变量名 类型  示例值 描述 
EROI id id String 5a28e437105d00b4ff3b7682 唯一标识一个EROI
所在场景ID   sceneId String 5a28e437105d00b4ff3b7683 唯一标识一个场景 
原始区域坐标 origin Object 略   区域坐标  
原始区域坐标 x origin.x Float 略   区域坐标 x  
原始区域坐标 y origin.y Float 略   区域坐标 y  
原始区域坐标 width origin.width Float 略   区域坐标 width  
原始区域坐标 height origin.height Float 略   区域坐标 height  

获取场景EROI

获取场景中需要在计算中剔除的区域

HTTP Request

GET https://api.camsgear.com/v1/scenes/:sceneId/erois

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
场景id  sceneId 是   String 略   场景ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热区列表   data Array 略   热区列表  
ROI id data.$.id String 5a28e437105d00b4ff3b7682 唯一标识一个EROI
所在场景ID   data.$.sceneId String 5a28e437105d00b4ff3b7683 唯一标识一个场景 
原始区域坐标 data.$.origin Object 略   区域坐标  
原始区域坐标 x data.$.origin.x Float 略   区域坐标 x  
原始区域坐标 y data.$.origin.y Float 略   区域坐标 y  
原始区域坐标 width data.$.origin.width Float 略   区域坐标 width  
原始区域坐标 height data.$.origin.height Float 略   区域坐标 height  

删除场景EROI

删除场景中需要在计算中剔除的区域

HTTP Request

DELETE https://api.camsgear.com/v1/erois/:eroiid

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
EROI id eroiid 是   String 略   EROI ID

Response

字段名 变量名 类型  示例值 描述 
是否删除成功 success Boolean true 是否删除成功

热区分析数据 (Heatmap Data) 模块

创建热区数据分析事件

创建Heatmap Data Event

HTTP Request

POST https://api.camsgear.com/developer/heatmaps/:heatmapId/events

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID
访问凭证   authorization 是   String 略   获取到的凭证

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  id 是   String 略   热区ID 

Body

字段名 变量名 必填  类型  示例值 描述 
数据事件名称 name 是   String 乐贝家周热区 数据事件名称
场景列表   scenes 否   Array 略   若不填,默认为热区下所有场景 
需要独立计算的ROIs   rois 否   Array 略   略  
需要排除计算的EROIs   erois 否   Array 略   略  
起止时间列表 timeslots 是   Array 略   略  
起止时间列表开始  timeslots.$.start 是   Date 略   每一段时间的开始 
起止时间列表结束  timeslots.$.end 是   Date 略   每一段时间的结束 
是否为周期事件   repeat 否   String none;day;week;month;season 默认为None, 若设置了周期时间,会按照
设置的timeslot中的时间进行周期计算  

Response

字段名 变量名 类型  示例值 描述 
数据事件Id   id String 略   数据事件名称
数据事件名称 name String 乐贝家周热区 数据事件名称
场景列表   scenes Array 略   略  
需要独立计算的ROIs   rois Array 略   略  
需要排除计算的EROIs   erois Array 略   略  
起止时间列表 timeslots Array 略   略  
起止时间列表开始  timeslots.$.start Date 略   每一段时间的开始 
起止时间列表结束  timeslots.$.end Date 略   每一段时间的结束 
是否为周期事件   repeat String 略   s

获取热区数据分析事件

获取热区中数据分析事件列表

HTTP Request

GET https://api.camsgear.com/developer/heatmaps/:heatmapId/events

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  id 是   String 略   热区ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
事件列表   data Array 略   事件列表  
数据事件Id   data.$.id String 略   数据事件名称
数据事件名称 data.$.name String 乐贝家周热区 数据事件名称
场景列表   data.$.scenes Array 略   略  
需要独立计算的ROIs   data.$.rois Array 略   略  
需要排除计算的EROIs   data.$.erois Array 略   略  
起止时间列表 data.$.timeslots Array 略   略  
起止时间列表开始  data.$.timeslots.$.start Date 略   每一段时间的开始 
起止时间列表结束  data.$.timeslots.$.end Date 略   每一段时间的结束 
是否为周期事件   data.$.repeat String 略  
事件任务列表 data.$.tasks Array 略  
事件任务列表 data.$.tasks.$status String init,running,success,failed 事件状态  

删除热区分析事件

删除热区分析事件

HTTP Request

DELETE https://api.camsgear.com/v1/heatmaps/:heatmapId/events/:eventId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  id 是   String 略   热区ID 
事件id  id 是   String 略   事件ID 

Response

字段名 变量名 类型  示例值 描述 
是否删除成功 success Boolean true 是否删除成功

获取热区分析事件数据

获取热区分析事件数据

HTTP Request

GET https://api.camsgear.com/v1/heatmaps/:heatmapId/events/:eventId/data

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
热区id  heatmapId 是   String 略   热区ID 
事件id  id 是   String 略   事件ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热区数据列表 data Array 略   热区列表  
数据 id  data.$id String 5a28e437105d00b4ff3b7682 唯一标识一个时间数据  
事件 id  data.$.eventId String 5a28e437105d00b4ff3b7683 数据所在的事件  
事件起始时间 data.$.timeSlot.start Date 略   事件起始时间
事件结束时间 data.$.timeSlot.end Date 略   事件结束时间
ROI 数据  data.$.roi Array 略   ROI数据 
ROI id data.$.roi.$.id String 略   ROI id
ROI 数据  data.$.roi.$.data Number 略   ROI 数据