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

请求示例:

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

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '0a2041a301c7bb1ccf5858a6e318eca4' }
]

body: {
    alias: 'outuserid',
    serialNumber: 'testserialnumber'
}

response: {
    authorization: 'FCCrWRokXABPmfwWR4QKwlt2eE3o4nbA1blG1gpHwbWQ0GPUplaG2d3hVXqPtsePNUOMTHD2IjwhoWwTNW7SFIDh8pIMw55DrImJW2jYnMAuM0MzlM1f3q3bOsVsf76zfZ54CVVQg9OSU7yAFgEinKiH40UoWCtXE5VOOgpQe7irnIm4lIeVIhmoWofZaluH8DThJDQdMDXyBBXvz8DNgL1DG9WMSRTDHJ57YVGnTsNvww95'
}

Headers

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

Body

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

Response

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

获取别名Token

通过别名获取对应用户AccessToken

HTTP Request

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

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
别名ID  alias 是   String 5a28c0089b3ff3 接入方用户ID或标识 

Response

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

获取应用设备列表

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

HTTP Request

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

请求示例:

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

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { signature: '0a2041a301c7bb1ccf5858a6e318eca4' }
]

response: {
    total: 1,
    skip: 0,
    data: [
        {
            serialNumber: 'PDS11Q79K0047',
            isOnline: true
        }
    ]
}

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 设备是否在线状态 

获取设备图片流日期列表

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

HTTP Request

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

请求示例1 (默认获取七天的数据列表):

Request: `GET https://api.camsgear.com/v1/applications/imagecams/days?serialNumber=PDS11Q79K0047`

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

response: {
    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 (获取指定日期,指定小时的数据列表):

Request: `GET https://api.camsgear.com/v1/applications/imagecams/days?hours=05,21,22&day=2017-09-28&serialNumber=PDS11Q79K0047`

headers: 略

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

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

请求示例3 (获取指定范围日期列表与记录条数限制):

Request: `GET https://api.camsgear.com/v1/applications/imagecams/days?day[$lt]=2017-09-24&$limit=3&serialNumber=PDS11Q79K0047`

headers: 略

// 返回日期小于2017-09-24的3条记录
response: {
    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

请求示例:

Request: `GET https://api.camsgear.com/v1/applications/imagecams/data?day=2017-09-02&hours=05&serialNumber=PDS11Q79K0047`

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

response: {
    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 略   相机拼接参数

用户(User)模块

发送验证码

用于用户注册时发送验证码

HTTP Request

POST https://api.camsgear.com/v1/users/verifyCode

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID

Body

字段名 变量名 必填  类型  示例值 描述 
手机号 phone 是   String 15067436455 注册用的手机号  
发送范围   scope 否   String signup 验证码范围,默认signup  

Response

字段名 变量名 类型  示例值 描述 
发送状态   success Boolean true 是否发送成功

用户注册

用户注册接口

HTTP Request

POST https://api.camsgear.com/v1/users/signup

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID

Body

字段名 变量名 必填  类型  示例值 描述 
手机号 phone 是   String 15067436455 注册用的手机号  
密码  password 是   String zhao1228 登录密码  
验证码 code 是   String 943088 收到的验证码

Response

字段名 变量名 类型  示例值 描述 
访问凭证   authorization String 略   获取到的凭证

用户登录

用户登录接口

HTTP Request

POST https://api.camsgear.com/v1/users/signin

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用分配的应用ID

Body

字段名 变量名 必填  类型  示例值 描述 
手机号 phone 是   String 15067436455 注册用的手机号  
密码  password 是   String zhao1228 登录密码  

Response

字段名 变量名 类型  示例值 描述 
访问凭证   authorization String 略   获取到的凭证

用户搜索

通过手机号搜索用户

HTTP Request

GET https://api.camsgear.com/v1/users/search

Headers

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

Query Parameters

字段名 变量名 必填 类型 示例值 描述
搜索值 s String 150 搜索内容

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
用户列表   data Array 略   用户列表  
用户ID  data.$.id String 略   用户唯一标识
手机号 data.$.phone String 略   手机号
邮箱  data.$.email String 略   邮箱地址  
用户资料   data.$.profile Object 用户资料  
昵称  data.$.profile.nickname String 略   昵称 
性别  data.$.profile.sex Number 略   0:未知 1:男性, 2:女性

设备列表

获取当前用户下的设备列表

请求示例:

Request: `GET https://api.camsgear.com/v1/users/devices`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: [
    {
        serialNumber: 'PDS11Q79K0047',
        license: 'abcedfg',
        isOnline: false
    },
    {
        serialNumber: 'PDS11Q79K0048',
        license: 'abcedfh',
        isOnline: false
    }
]

HTTP Request

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

Headers

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

Response

字段名 变量名 类型  示例值 描述 
设备序列号  $.serialNumber String PDS11Q79K0047 设备的唯一编码  
连接许可   $.license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可
在线状态   $.isOnline Boolean false 设备是否在线

设备绑定

通过扫描二维码等形式,绑定设备到用户下 注: 设备需先进行配置!!

HTTP Request

POST https://api.camsgear.com/v1/users/bindDevice

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备的唯一编码  

Response

字段名 变量名 类型  示例值 描述 
绑定状态   success Boolean true 是否绑定成功

获取被邀请的IPCam列表

获取当前用户被邀请的IPCam列表

请求示例:

Request: `GET https://api.camsgear.com/v1/users/invitations/ipcam`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
  total: 1,
  skip: 0,
  limit: 7,
  data: [
    {
      id: '5a295ca5f011ec5e3d3787e3',
      title: '',
      serialNumber: 'PDS10Q0000047',
      creater: 'aliasid',
      license: '9ENYG3410WB6P460JJUS',
      mediaInfo: {...},
      calibration: '...',
      createdAt: '2017-12-14T07:12:39.079Z'
    }
  ]
}

HTTP Request

GET https://api.camsgear.com/v1/users/invitations/ipcam

Headers

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

Response

字段名 变量名 类型  示例值 描述 
IPCam标题  $.title String Edwin家的监控   IPCam的标题
设备序列号  $.license String(20) PDS11Q79K0047 设备的序列号
创建者的别名 $.creater String 5a295ca5f011ec5e3d3787e3 创建者的别名
创建者昵称  $.ownerProfile.nickname String(20) 137****6781 创建者的昵称
连接设备许可 $.license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可
MediaInfo $.mediaInfo Object ... 表示视频类型的MediaInfo  
标定参数   $.calibration Object ... 设备标定参数
创建时间   $.createdAt String(20) ... IPCam创建的时间 

设备(Device)模块

获取连接ID

App请求连接设备,获取请求连接ID

HTTP Request

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

Headers

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

Response

字段名 变量名 类型  示例值 描述 
连接ID  connectionId String(16) dcSc9bbNkmel5kYM 用于验证连接请求的ID

分配license(设备接口)

设备接口,通过连接ID、设备号分配p2p的license

HTTP Request

POST https://api.camsgear.com/v1/devices/assignLicense

Headers

字段名 变量名 必填  类型  示例值 描述 
签名  signature 是   String(32) 略   设备端签名不需要appSecret,通过时间戳加密,详见设备端签名文档

Body

字段名 变量名 必填  类型  示例值 描述 
连接ID  connectionId 是   String(16) dcSc9bbNkmel5kYM 用于验证连接请求的ID
设备序列号  serialNumber 是   String PDS11Q79K0047 设备的唯一编码  
时间戳 timestamp 是   String 1513328141 发送请求时的UTC时间戳
时区  timezone 否   String +0800 时区 

Response

字段名 变量名 类型  示例值 描述 
连接许可   license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可

获取license(通过连接ID)

通过连接请求ID(connectionId)获取连接许可(license)

HTTP Request

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

Headers

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

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
连接ID  connectionId 是   String(16) dcSc9bbNkmel5kYM 用于验证连接请求的ID

Response

字段名 变量名 类型  示例值 描述 
设备序列号  serialNumber String PDS11Q79K0047 设备的唯一编码  
连接许可   license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可

获取license(通过设备号)

通过设备号(serialNumber)获取连接许可(license)

HTTP Request

GET https://api.camsgear.com/v1/devices/:serialNumber/license

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备的唯一编码  

Response

字段名 变量名 类型  示例值 描述 
连接许可   license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可

设置IP

相机设置SSID与IP接口

HTTP Request

POST https://api.camsgear.com/v1/devices/ip

Headers

字段名 变量名 必填  类型  示例值 描述 
签名  signature 是   String(32) 略   设备端签名不需要appSecret,通过时间戳加密,详见设备端签名文档

Body

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备序列号,唯一标识一台设备  
设备内网IP   ip 是   String 192.168.31.138 设备IP 
网络连接名  ssid 是   String Camdora 设备连接的网络名字
请求时间戳  timestamp 是   String 1513158133 发送请求时的UTC时间戳

Response

字段名 变量名 类型  示例值 描述 
请求状态   success Boolean true 是否设置成功

获取上传Token

获取设备端移动报警上传token

HTTP Request

GET https://api.camsgear.com/v1/devices/upload/token

Headers

字段名 变量名 必填  类型  示例值 描述 
签名  signature 是   String(32) 略   设备端签名不需要appSecret,通过时间戳加密,详见设备端签名文档

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备序列号,唯一标识一台设备  
上传类型   type 是   String playback ['alert', 'playback', 'imagecam']中选一个 
请求时间戳  timestamp 是   String 1513158133 发送请求时的UTC时间戳

Response

字段名 变量名 类型  示例值 描述 
上传路径前缀 path String 596216a87e45ee027e5e16bd/PDS11Q79K0047 限定的上传目录前缀
上传的key accessKeyId String 9YGYfI0jGGl3x6gT 上传的key
上传域名   host String http://camdora-alerts.oss-cn-hangzhou.aliyuncs.com 上传域名  
上传策略   policy String 略   编码后的策略字符串,限定了上传文件的限制,如文件大小,目录位置等
签名  signature String 略   验证的签名 

有线连接初始化

设备连接有线后的初始化接口 包括生成设备用户、创建图片流、分配license、获取上传token

Headers

字段名 变量名 必填  类型  示例值 描述 
签名  signature 是   String(32) 略   设备端签名不需要appSecret,通过时间戳加密,详见设备端签名文档

Body

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备序列号,唯一标识一台设备  
请求时间戳  timestamp 是   String 1513158133 发送请求时的UTC时间戳
拼接参数   calibration 是   String 略   相机拼接参数
图像信息   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 一帧中画面的排列顺序  

Response

字段名 变量名 类型  示例值 描述 
连接许可   license String(20) 5WAXDFHGDYEKFPG70K2B 用于建立连接的许可

获取最新固件(设备接口)

获取最新固件的下载地址

HTTP Request

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

Headers

字段名 变量名 必填  类型  示例值 描述 
签名  signature 是   String(32) 略   设备端签名不需要appSecret,通过时间戳加密,详见设备端签名文档

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
型号  modelNumber 是   String 661111 设备型号  
当前固件版本 version 是   String 0.0.9 固件版本号 

Response

字段名 变量名 类型  示例值 描述 
是否需要更新 needUpgrade Boolean true 是否需要更新
固件下载地址 url String https://camdora-static.oss-cn-hangzhou.aliyuncs.com/firmware/661111/camdora-661111-1.1.2-20171016124821-34af049.ius 仅当needUpgrade为true时返回该值 
固件版本号  version String 1.0.0 仅当needUpgrade为true时返回该值 
校验码 checkCode String 略   仅当needUpgrade为true时返回该值 

图片流(ImageCam)模块

创建图片流

创建图片流

HTTP Request

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

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备的唯一编码  
拼接参数   calibration 是   String 略   相机拼接参数
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 一帧中画面的排列顺序  

Response

字段名 变量名 类型  示例值 描述 
图片流ID id String(24) 5a211d4c6f76ee667b8e309d 创建的图片流ID
设备序列号  serialNumber String PDS11Q79K0047 设备的唯一编码  
拼接参数   calibration String 略   相机拼接参数
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 一帧中画面的排列顺序  

图片流列表

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

请求示例:

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

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    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
            },
            appID: 'lP0Zn8Dc1Xu6inDx',
            calibration: 'version=v1&type=1&data=0.506899,0.500496,0.499081,1.735190,3.000000,-0.004580,-0.004580,0.999990,2.000000,-0.075012,-0.074942,0.997188,1.000000,-0.017050,-0.017049,0.999855;0.495440,1.506414,0.499081,1.752693,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000;0.545065,0.583850,0.669243,0.920500,0.139637,0.799791,0.361254,0.766398,0.778474,0.777887,0.249058,0.313661,0.021892,0.618356,0.491083,0.479844;0.765114,0.834098,0.972073,0.791082,0.977495,0.163225,0.300037,0.100382,0.248349,0.177191,0.731962,0.011260,0.059253,0.369706,0.275889,0.769291',
            thumbnail: {
                url: 'http://imagecam-thumbnails.gearcdn.com/PDS11Q79K0047-5a65aa1143fa8a0d3c567576.jpg'
            }
        },
        { 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 设备序列号,唯一标识一台设备  
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 一帧中画面的排列顺序  
拼接参数   data.$.calibration String 略   相机拼接参数
缩略图 data.$.thumbnail Object 略   缩略图
data.$.thumbnail.url String 略   缩略图CDN地址 

图片流详情

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

请求示例:

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    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 (默认获取七天的数据列表):

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    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 (获取指定日期,指定小时的数据列表):

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days?hours=05,21,22&day=2017-09-28`

headers: 同上

// 若没有22小时的数据,则不返回对应小时数
response: {
    total: 1,
    skip: 0,
    data: [
        {
        day: '2017-09-28',
        hours: [
                { hour: 05 },
                { hour: 21 }
            ]
        }
    ]
}

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

请求示例3 (获取指定范围日期列表与记录条数限制):

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/days?day[$lt]=2017-09-24&$limit=3`

headers: 同上

// 返回日期小于2017-09-24的3条记录
response: {
    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/:imagecamId/days

Headers

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

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:

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/data?day=2017-09-02&hours=05`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    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参数后的返回值):

Request: `GET https://api.camsgear.com/v1/imagecams/5a28e437105d00b4ff3b7682/data?day=2017-09-02&hours=05&needTimestamp=true`

headers: 略

response: {
    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/:imagecamId/data

Headers

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

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.$
(默认模式)  
String http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/1504299600000.jpg 图片的路径 
图片地址路径(扩展模式)   $.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 略   相机拼接参数

监控(Ipcam)模块

创建监控

创建监控接口

HTTP Request

POST https://api.camsgear.com/v1/ipcams

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
标题  title 否   String 卧室  可用来标记位置,不传该值,后台默认填写 用户名+的监控
设备号 serialNumber 是   String PDS11Q79K0047 设备的唯一编码  
拼接参数   calibration 是   String 略   相机拼接参数
图像信息   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 一帧中画面的排列顺序  

Response

字段名 变量名 类型  示例值 描述 
图片流ID id String(24) 5a211d4c6f76ee667b8e309d 创建的图片流ID
标题  title String 卧室  监控标题  
设备序列号  serialNumber String PDS11Q79K0047 设备的唯一编码  
拼接参数   calibration String 略   相机拼接参数
图像信息   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 一帧中画面的排列顺序  

获取可用设备列表

获取可用设备列表

HTTP Request

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

Headers

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

Response

字段名 变量名 类型  示例值 描述 
设备列表   devices Array 略   设备列表  
devices.$.serialNumber String 略   设备编号  
devices.$.license String 略   license

修改监控

修改监控

HTTP Request

PATCH https://api.camsgear.com/v1/ipcams/:id

Headers

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

URL Parameters

字段名 变量名 必填 类型 示例值 描述
id id String 5aaa57b5bc7b47aa3358543a ipcamID或设备号

Body

字段名 变量名 必填  类型  示例值 描述 
监控名 title 是   String 商场一层   监控名

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

删除监控

删除监控

HTTP Request

DELETE https://api.camsgear.com/v1/ipcams/:id

Headers

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

URL Parameters

字段名 变量名 必填 类型 示例值 描述
id id String 5aaa57b5bc7b47aa3358543a ipcamID或设备号

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

监控列表

获取用户下创建的监控列表

HTTP Request

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

Headers

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

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
图片流列表  data Array 略   图片流列表 
图片流ID data.$.id String 5a28e437105d00b4ff3b7682 唯一标识一个图片流
标题  data.$.title String 卧室  监控标题  
设备序列号  data.$.serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备  
邀请列表   data.$.invitations Array 邀请列表  
被邀请者ID   data.$.invitations.$.id String 被邀请者ID(中咖助手下与alias相同)
被邀请者手机号   data.$.invitations.$.phone String 被邀请者手机号  
黑名单 data.$.blockList Array 黑名单
被踢除者ID   data.$.blockList.$.id String 被踢除者ID(中咖助手下与alias相同)
被踢除者手机 data.$.blockList.$.phone String 被踢除者手机
拼接参数 data.$.calibration String 相机拼接参数
图像信息 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 一帧中画面的排列顺序

监控详情

通过监控ID或设备号获取监控详情

HTTP Request

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

Headers

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

URL Parameters

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

Response

字段名 变量名 类型  示例值 描述 
图片流ID id String 5a28e437105d00b4ff3b7682 唯一标识一个图片流
标题  title String 卧室  监控标题  
设备序列号  serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备  
邀请列表   data.$.invitations Array 邀请列表  
被邀请者ID   data.$.invitations.$.id String 被邀请者ID(中咖助手下与alias相同)
被邀请者手机号   data.$.invitations.$.phone String 被邀请者手机号  
黑名单 data.$.blockList Array 黑名单
被踢除者ID   data.$.blockList.$.id String 被踢除者ID(中咖助手下与alias相同)
被踢除者手机 data.$.blockList.$.phone String 被踢除者手机
拼接参数 calibration String 相机拼接参数
图像信息 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 一帧中画面的排列顺序

获取访问STS Token

获取访问权限token

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/token

Headers

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

URL Parameters

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

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
token类型  type 是   String playback ['playback', 'alert']中选一个 

Response

字段名 变量名 类型  示例值 描述 
oss地区  region String oss-cn-hangzhou 初始化阿里云sdk参数 
bucket名   bucket String camsgear-playbacks-demo 访问的bucket名  
访问key  AccessKeyId String CdDRhfNWNv1GwyNBD65NUFZiGY7eEvYtCeKydFHE8itk 初始化阿里云sdk参数 
访问秘钥   AccessKeySecret String STS.LZAqWn7Kp53hrsRs2hbtYTWYW 初始化阿里云sdk参数 
过期时间   Expiration String 2017-11-23T13:23:02Z 初始化阿里云sdk参数 
安全秘钥   SecurityToken String 略   初始化阿里云sdk参数 

监控邀请

邀请其他人观看监控

HTTP Request

POST https://api.camsgear.com/v1/ipcams/:id/invite

Headers

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

URL Parameters

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

Body

字段名 变量名 必填  类型  示例值 描述 
邀请列表   invites 是   Array ['alias1', 'alais2'] 邀请别名列表

Response

字段名 变量名 类型  示例值 描述 
请求状态   success Boolean true 是否设置成功

监控踢除

踢除邀请观看监控的人

HTTP Request

POST https://api.camsgear.com/v1/ipcams/:id/kick

Headers

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

URL Parameters

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

Body

字段名 变量名 必填  类型  示例值 描述 
黑名单 blockList 是   Array ['alias1', 'alais2'] 要踢除的人的别名列表  

Response

字段名 变量名 类型  示例值 描述 
请求状态   success Boolean true 是否设置成功

获取邀请列表

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/invitations

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/invitations`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    data: [
        {
            owner: '5a61b98b26da4c6ff131d1c2',
            alias: 'vincenthzhao'
        },
        {
            owner: '5a61b98b26da4c6ff131d1c4',
            alias: 'edwincen'
        }
    ]
}

Headers

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

URL Parameters

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

Response

字段名 变量名 类型  示例值 描述 
返回数据   data Array 略   返回数据  
用户ID data.$.owner String CamsgearKit用户ID
别名 data.$.alias String 接入方别名

获取黑名单

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/blockList

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/blockList`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    data: [
        {
            owner: '5a61b98b26da4c6ff131d1c2',
            alias: 'fishchen'
        },
        {
            owner: '5a61b98b26da4c6ff131d1c4',
            alias: 'yiven'
        }
    ]
}

Headers

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

URL Parameters

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

Response

字段名 变量名 类型  示例值 描述 
返回数据   data Array 略   返回数据  
用户ID data.$.owner String CamsgearKit用户ID
别名 data.$.alias String 接入方别名

移动报警列表

返回移动报警列表

请求示例:

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/alerts`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    total: 2,
    skip: 0,
    data: [
        {
            id: '5a3cd90a9ee4f65510a44b7d',
            serialNumber: 'testcase1',
            type: 'motion',
            mediaType: 'mp4',
            start: '1512802460',
            trigger: '1512802490',
            duration: 15,
            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',
            path: '5a337182ba4c7f128e7213a1/testcase1/test2.mp4',
            timezone: '+0800',
            owner: '5a337182ba4c7f128e7213a1'
        },
        { id: '5a3cd90a9ee4f65510a44b7c', serialNumber: 'testcase1', type: 'motion', mediaType: 'mp4', …}
    ]
}

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/alerts

Headers

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

URL Parameters

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

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
报警列表   data Array 略   报警列表  
报警ID  data.$.id String 5a28e437105d00b4ff3b7682 唯一标识一个报警 
设备序列号  data.$.serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备  
拼接参数   data.$.calibration String 略   相机拼接参数
图像信息   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.$.type String motion 移动报警的类别,区分不同类型的报警  
报警文件类型 data.$.mediaType String mp4 上传的移动报警文件格式 
文件路径   data.$.path String 略   文件oss路径  
设备时间戳  data.$.timezone String +0800 设备设置的时间戳 
开始时间戳(utc)  data.$.start String 略   报警开始的时间戳 
报警触发时间戳(utc)   data.$.trigger String 略   报警触发的时间戳 
报警时长   data.$.duration Number 15 报警总时长 

移动报警详情

获取移动报警详情(用于推送后获取移动报警信息)

请求示例:

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/alerts/5a3cd90a9ee4f65510a44b7d`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    id: '5a3cd90a9ee4f65510a44b7d',
    serialNumber: 'testcase1',
    type: 'motion',
    mediaType: 'mp4',
    start: '1512802460',
    trigger: '1512802490',
    duration: 15,
    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',
    path: '5a337182ba4c7f128e7213a1/testcase1/test2.mp4',
    timezone: '+0800',
    owner: '5a337182ba4c7f128e7213a1'
}

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/alerts/:alertId

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
监控标识ID   id 是   String PDS11Q79K0047 设备号或者监控ID  
移动报警ID   id 是   String 5a3cd90a9ee4f65510a44b7d 有列表返回或推送返回  

Response

字段名 变量名 类型  示例值 描述 
报警ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个报警 
设备序列号  serialNumber String PDS11Q79K0047 设备序列号,唯一标识一台设备  
拼接参数   calibration String 略   相机拼接参数
图像信息   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 一帧中画面的排列顺序  
报警类型   type String motion 移动报警的类别,区分不同类型的报警  
报警文件类型 mediaType String mp4 上传的移动报警文件格式 
文件路径   path String 略   文件oss路径  
设备时间戳  timezone String +0800 设备设置的时间戳 
开始时间戳(utc)  start String 略   报警开始的时间戳 
报警触发时间戳(utc)   trigger String 略   报警触发的时间戳 
报警时长   duration Number 15 报警总时长 

云回放日期列表

云端回放日期列表

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/playbacks/days

请求示例:

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/playbacks/days`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    total: 1,
    limit: null,
    skip: 0,
    data:[{
        day: '2017-12-09',
        hours:[{
            hour: '14'
        }]
    }]
}

Headers

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

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 小时数(若当前小时无数据,则不返回)

云回放数据列表

云端回放数据列表

HTTP Request

GET https://api.camsgear.com/v1/ipcams/:id/playbacks/data

请求示例:

Request: `GET https://api.camsgear.com/v1/ipcams/testcase1/playbacks/data?day=2017-12-09`

headers: [
    { appid: 'lP0Zn8Dc1Xu6inDx' },
    { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
    day: '2017-12-09',
    hours:[{
        hour: '14',
        resources:[
        {
            path: 'http://camsgear-playbacks-demo.oss-cn-hangzhou.aliyuncs.com/5a24c3d393e80d5355b03923/testcase1/test.mp4',
            timestamp: '1512802459000'
        }]
    }],
    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,唯一标识一个应用  
访问凭证   authorization 是   String 略   绑定用户时获取的凭证  

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
指定的日期  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 略   相机拼接参数

监控回放回调(callback)

此接口为阿里云回调调用, 请查看上传监控回放时所需要上传的参数

示例:

curl -s -k \
-F "x:owner=5a24c3d393e80d5355b03923" \
-F "x:start=1512802459000" \
-F "x:timezone=+0800" \
-F "x:duration=15" \
-F "x:mediatype=mp4" \
-F "x:serialnumber=testcase1" \
-F "key=5a24c3d393e80d5355b03923/testcase1/test.mp4" \
-F "OSSAccessKeyId=9YGVeI0jFFl3x6gT" \
-F "policy=eyJleHBpcmF0aW9uIjoiMjAxNy0xMi0yN1QwNzoyMDoyNS40MjZaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiY2Ftc2dlYXItcGxheWJhY2tzLWRlbW8ifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDUyNDI4ODAwMDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiNWEyNGMzZDM5M2U4MGQ1MzU1YjAzOTIzL3Rlc3RjYXNlMSJdXX0=" \
-F "signature=UCfX6Ni2trBvUt+mGcMuZ9Ag7yY=" \
-F "file=@/Users/zhaoyang/Desktop/test.mp4" \
"http://camsgear-playbacks-demo.oss-cn-hangzhou.aliyuncs.com"

Params

字段名 变量名 必填  类型  示例值 描述 
用户ID  x:owner 是   String 5a337182ba4c7f128e7213a1 由获取上传token接口返回的path值分割获得
回放片段开始时间戳(utc) x:start 是   String(13) 1512802489000 utc时间戳,精确到毫秒, 13位
时区  x:timezone 是   String +0800 设备所在时区
回放片段总时长   x:duration 是   String 15 时长秒数,后台会自动转化为数字类型  
回放文件类型 x:mediatype 是   String mp4 回放文件类型
设备号 x:serialnumber 是   String testcase1 设备号
上传路径   key 是   String 5a337182ba4c7f128e7213a1/testcase1/test.mp4 上传到oss上的路径  
访问key  OSSAccessKeyId 是   String 9YGVeI0jGGl3x6gT 由获取上传token接口返回
策略  policy 是   String 略   由获取上传token接口返回
签名  signature 是   String 略   由获取上传token接口返回
本地文件路径 file 是   String @/Users/zhaoyang/Desktop/test.mp4 本地文件路径,前面一定要加@符号 
上传域名   host 是   String http://camsgear-playbacks-demo.oss-cn-hangzhou.aliyuncs.com 由获取上传token接口返回

移动报警回调(callback)

此接口为阿里云回调调用, 请查看上传移动报警时所需要上传的参数

示例:

curl -s -k \
-F "x:owner=5a24c3d393e80d5355b03923" \
-F "x:type=motion" \
-F "x:start=1512802459000" \
-F "x:trigger=1512802489000" \
-F "x:timezone=+0800" \
-F "x:duration=15" \
-F "x:mediatype=mp4" \
-F "x:serialnumber=testcase1" \
-F "key=5a24c3d393e80d5355b03923/testcase1/test.mp4" \
-F "OSSAccessKeyId=9YGVeI0jFFl3x6gT" \
-F "policy=eyJleHBpcmF0aW9uIjoiMjAxNy0xMi0yMlQxMTowNToyNC4wNjFaIiwiY29uZGl0aW9ucyI6W3siYnVja2V0IjoiY2Ftc2dlYXItYWxlcnRzLWRlbW8ifSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDUyNDI4ODAwMDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiNWEyNGMzZDM5M2U4MGQ1MzU1YjAzOTIzL3Rlc3RjYXNlMSJdXX0=" \
-F "signature=0ALvACbSumFBXnIBNCEXL1cKIr4=" \
-F "file=@/Users/zhaoyang/Desktop/test.mp4" \
"http://camsgear-alerts-demo.oss-cn-hangzhou.aliyuncs.com"

Params

字段名 变量名 必填  类型  示例值 描述 
用户ID  x:owner 是   String 5a337182ba4c7f128e7213a1 由获取上传token接口返回的path值分割获得
报警类型   x:type 是   String motion 由获取上传token接口返回的path值分割获得
报警开始时间戳(utc)   x:start 是   String(13) 1512802489000 utc时间戳,精确到毫秒, 13位
报警发生时间戳(utc)   x:trigger 是   String(13) 1512802489000 utc时间戳,精确到毫秒, 13位
时区  x:timezone 是   String +0800 设备所在时区
报警总时长  x:duration 是   String 15 时长秒数,后台会自动转化为数字类型  
报警文件类型 x:mediatype 是   String mp4 报警文件类型
设备号 x:serialnumber 是   String testcase1 设备号
上传路径   key 是   String 5a337182ba4c7f128e7213a1/testcase1/test.mp4 上传到oss上的路径  
访问key  OSSAccessKeyId 是   String 9YGVeI0jGGl3x6gT 由获取上传token接口返回
策略  policy 是   String 略   由获取上传token接口返回
签名  signature 是   String 略   由获取上传token接口返回
本地文件路径 file 是   String @/Users/zhaoyang/Desktop/test.mp4 本地文件路径,前面一定要加@符号 
上传域名   host 是   String http://camsgear-alerts-demo.oss-cn-hangzhou.aliyuncs.com 由获取上传token接口返回

算法(Algorithm)模块 - 回朔巡检

获取创建可用设备列表

获取回朔巡检未被添加过的设备列表

HTTP Request

GET https://apis.camsgear.com/v1/algorithm/backtrace/devices

Headers

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

Response

字段名 变量名 类型  示例值 描述 
设备列表   devices Array 略   设备列表  
devices.$.serailNumber String 设备号

创建回朔巡检

创建回朔巡检

HTTP Request

POST https://apis.camsgear.com/v1/algorithm/backtrace

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
分组名 name 是   String 商场一层   分组名
设备号 serialNumber 是   String PDS11Q79K0022 设备号

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

获取回朔巡检列表

获取回朔巡检列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/backtrace

Headers

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

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热点分组列表 data Array 略   热点分组列表
data.$.id String 5aaa57b5bc7b47aa3358543a 热点分组ID  
data.$.name String 分组1  热点分组名 
data.$.createdAt String 略   创建时间  
data.$.serialNumber String 略   设备号
data.$.thumbnail Object 略   缩略图
data.$.thumbnail.url String 略   缩略图路径 

编辑回朔巡检

编辑回朔巡检

HTTP Request

PATCH https://api.camsgear.com/v1/algorithm/backtrace/:id

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
id id 是   String 略   回朔巡检ID或设备号 

Body

字段名 变量名 必填  类型  示例值 描述 
回朔巡检名  name 是   String 商场一层   回朔巡检名 

Response

字段名 变量名 类型  示例值 描述 
修改状态   success Boolean true 修改状态  

删除回朔巡检

删除回朔巡检

HTTP Request

DELETE https://api.camsgear.com/v1/algorithm/backtrace/:id

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
id id 是   String 略   回朔巡检ID或设备号 

Response

字段名 变量名 类型  示例值 描述 
删除状态   success Boolean true 删除状态  

获取回朔巡检日期列表

获取某一台设备存在回朔巡检的日期列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/backtrace/:id/days

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
id id 是   String 略   回朔巡检ID或设备号 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
日期列表   data Array 略   日期列表  
data.$.day String '2018-03-09' 日期 

回朔巡检数据列表

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

HTTP Request

GET GET https://api.camsgear.com/v1/algorithm/backtrace/:id/data

Headers

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

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
指定的日期  day 是   String 2017-09-21 获取指定日期的数据列表 

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位,精确到毫秒) 
图像信息   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 略   相机拼接参数

算法(Algorithm)模块 - 热点统计

获取热点创建可用设备列表

获取未被添加过的设备列表

HTTP Request

GET https://apis.camsgear.com/v1/algorithm/counting/devices

Headers

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

Response

字段名 变量名 类型  示例值 描述 
设备列表   devices Array 略   设备列表  
devices.$.serailNumber String 略   设备号

创建热点统计

创建热点统计

HTTP Request

POST https://apis.camsgear.com/v1/algorithm/counting

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
分组名 name 是   String 商场一层   分组名
设备列表   serialNumbers 是   Array ['PDS11Q79K0022','PDS11Q79K0032'] 分组下的设备列表 

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

获取热点场景(分组)列表

获取热点分组列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/counting/scenes

Headers

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

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热点分组列表 data Array 略   热点分组列表
data.$.id String 5aaa57b5bc7b47aa3358543a 热点分组ID  
data.$.name String 分组1  热点分组名 
data.$.createdAt String 略   创建时间  
data.$.peakCount Number 略   峰值人数  
data.$.peakTimestamp String 略   峰值时间戳 
data.$.devices Array ["PDS11Q79K0047", "PDS11Q79K0025"] 分组下设备列表  
data.$.thumbnail Object 略   缩略图
data.$.thumbnail.url String 略   缩略图url

编辑热点场景(分组)

编辑热点场景(分组)名

HTTP Request

PATCH https://api.camsgear.com/v1/algorithm/counting/scenes/:sceneId

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
分组ID  scendId 是   String 5aaa57b5bc7b47aa3358543a 分组ID,由列表获取 

Body

字段名 变量名 必填  类型  示例值 描述 
分组名 name 是   String 商场一层   分组名

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

删除热点分组

删除热点场景(分组)以及设备

HTTP Request

DELETE https://api.camsgear.com/v1/algorithm/counting/scenes/:sceneId

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
分组ID  scendId 是   String 5aaa57b5bc7b47aa3358543a 分组ID,由列表获取 

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

获取热点分组数据

获取热点分组下每台设备的人数统计信息列表

Request: `GET https://api.camsgear.com/v1/algorithm/counting/scenes/5acad8f174fb2376ffa4577b/count?start=1523116800000&end=1523203199000&interval=hour`

Headers: [
  { appid: 'lP0Zn8Dc1Xu6inDx' },
  { authorization: 'OArr3fpiEHfepFS9s8cmjc5sroE5GZglVHcE17WBNNqaZss1UlIJ295GqKrjsf346TNdp6z3vCyLXvrphy2fNWTHfbobDKKCE45LyK2JIl4NneKh5QxU8o7H1RU0l9GCMmNd0M9V11I6Ez9XSzoPBKCQJ0YuMD9nYpdF0LyEkAhoWvmnQpcQYcZIbUEt4tmmlTdOD56NAre5IhSwKQQTG6NMKshP3ILzpwIacxvPmbDw7OZM' }
]

response: {
  devices: [
    {
      name: 'PDS11Q7AM0031',
      data: [
        [1523116800000, 547],
        [1523120400000, 630],
        [1523124000000, 613],
        [1523127600000, 660],
        [1523131200000, 632],
        [1523134800000, 616],
        [1523138400000, 655],
        [1523142000000, 702],
        [1523145600000, 614],
        [1523149200000, 548],
        [1523152800000, 590],
        [1523156400000, 671],
        [1523160000000, 565],
        [1523163600000, 522],
        [1523167200000, 541],
        [1523170800000, 579],
        [1523174400000, 519],
        [1523178000000, 594],
        [1523181600000, 562],
        [1523185200000, 611],
        [1523188800000, 627],
        [1523192400000, 588],
        [1523196000000, 615],
        [1523199600000, 557]
      ]
    },
    { name: 'PDS11Q7AM0165', data: [ [1523116800000, 610 ], [1523120400000, 559], …] }
  ]
}

HTTP Request

GET https://api.camsgear.com/v1/algorithm/counting/scenes/:sceneId/count

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
分组ID  scendId 是   String 5aaa57b5bc7b47aa3358543a 分组ID,由列表获取 

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
数据起始时间戳   start 是   String 1523116800000 数据起始时间戳  
数据结束时间戳   end 是   String 1523203199000 数据结束时间戳  
时区  timezone 否   String +0800 时区,默认+0800  
数据显示时间间隔  interval 否   String minute 默认minute, 可选值['mintue', 'hour', 'day']

Response

字段名 变量名 类型  示例值 描述 
设备列表   devices Array 略   场景下每台设备的数据  

算法(Algorithm-Hotarea)热区分析模块

获取热区创建可用设备列表

获取热区创建可用设备列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/hotarea/devices

Headers

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

Response

字段名 变量名 类型  示例值 描述 
设备列表   devices Array 略   设备列表  
devices.$.serailNumber String 略   设备号

创建热区分析

创建热区分析

HTTP Request

POST https://apis.camsgear.com/v1/algorithm/hotarea

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
分组名 name 是   String 商场一层   分组名
设备列表   serialNumbers 是   Array ['PDS11Q79K0022','PDS11Q79K0032'] 分组下的设备列表 

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

获取热区场景(分组)列表

获取热区场景(分组)列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/hotarea/scenes

Headers

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

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
热点分组列表 data Array 略   热点分组列表
data.$.id String 5aaa57b5bc7b47aa3358543a 热点分组ID  
data.$.name String 分组1  热点分组名 
data.$.createdAt String 略   创建时间  
data.$.devices Array ["PDS11Q79K0047", "PDS11Q79K0025"] 分组下设备列表  
data.$.url String 略   跳转url 

编辑热区场景(分组)

编辑热区场景(分组)

HTTP Request

PATCH https://api.camsgear.com/v1/algorithm/hotarea/scenes/:sceneId

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
分组ID  scendId 是   String 5aaa57b5bc7b47aa3358543a 分组ID,由列表获取 

Body

字段名 变量名 必填  类型  示例值 描述 
分组名 name 是   String 商场一层   分组名

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

删除热区分组

删除热区分组

HTTP Request

DELETE https://api.camsgear.com/v1/algorithm/hotarea/scenes/:sceneId

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
分组ID  scendId 是   String 5aaa57b5bc7b47aa3358543a 分组ID,由列表获取 

Response

字段名 变量名 类型  示例值 描述 
创建状态   success Boolean true 创建状态  

算法(Algorithm)模块 - AI Engine

获取设点图片流数据

获取指定设备、指定日期的图片流数据列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/couting/devices/:serialNumber/data

Headers

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

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备的唯一编码  

Query Parameters

注:day 或者 start、end 其中一组必填即可;若所有数据都传,默认采用start、end这组数据

字段名 变量名 必填  类型  示例值 描述 
指定的日期  day 是   String 2017-09-21 获取指定日期的数据列表 
时区  timezone 否   String +0800 时区 
开始时间戳  start 是   String 略   图片流数据开始时间戳,精确到毫秒(包含当前时间戳)  
结束时间戳  end 是   String 略   图片流数据结束时间戳,精确到毫秒(包含当前时间戳)  

Response

字段名 变量名 类型  示例值 描述 
设备序列号  serialNumber String PDS11Q79K0047 设备的唯一编码  
搜索开始时间戳   start String 1515081600000 13位时间戳  
搜索结束时间戳   end String 1515168000000 13位时间戳  
设备位置信息 position Object 略   设备位置信息,手动添加  
设备x轴位置  position.x Int 1200 设备x轴位置,单位厘米
设备y轴位置  position.y Int 325 设备y轴位置,单位厘米
设备离地高度 height Int 2700 设备离地高度,单位厘米  
额外信息   extra Object 略   API作filter用,返回结果时原样返回 
场景ID  extra.sceneId String 5a784b95ad6b3e7b201b1917 场景ID 
设备用户ID   extra.deviceOwner String 5a58685382e90d343c27245a 设备用户ID  
图片数据列表 data Array 略   图片数据列表
图片数据时间戳   data.$.timestamp String 1515119120353 图片13位时间戳
图片数据路径 data.$.path String http://event-notice-test.oss-cn-hangzhou.aliyuncs.com/5a36cb3b2b48a31b08173338/PDS11Q79K0044/20180105/02/0025.jpg 图片访问路径

报告热点图片流热区数据

报告图片流热区分析结果

HTTP Request

POST https://api.camsgear.com/v1/algorithm/counting/report

Headers

注: 由于当前接口body不较长,鉴权还没想好怎么做,先传一个appID,签名先不传!!

字段名 变量名 必填  类型  示例值 描述 
应用ID  appid 是   String(16) lP0Zn8Dc1Xu6inDx 创建应用时分配的ID,唯一标识一个应用  

Body

字段名 变量名 必填  类型  示例值 描述 
设备序列号  serialNumber 是   String PDS11Q79K0047 设备序列号 
图片流时间戳 timestamp 是   String 1513523024893 图片流时间戳
额外字段   extra 是   Object 略   原样返回获取时的字段  
extra.sceneId 是   String 5a784b95ad6b3e7b201b1917 场景ID 
extra.deviceOwner 是   String 5a58685382e90d343c27245a 设备用户ID  
绝对位置列表 absolutePosition 是   Array 略   绝对位置列表
absolutePosition.$.x 是   Int 略   x轴绝对位置 
absolutePosition.$.y 是   Int 略   y轴绝对位置 
相对位置列表 detectBox 是   Array 略   相对位置列表
detectBox.$.x 是   Int 略   相对位置方框左上角顶点x轴位置 
detectBox.$.y 是   Int 略   相对位置方框左上角顶点y轴位置 
detectBox.$.h 是   Int 略   相对位置方框高度 
detectBox.$.w 是   Int 略   相对位置方框宽度 

Response

字段名 变量名 类型  示例值 描述 
报告状态   success Boolean true 报告状态  

获取黑白图数据

获取图片流黑白图的数据列表

HTTP Request

GET https://api.camsgear.com/v1/algorithm/bwdata

Headers

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

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
设备号 serialNumber 是   String PDS11Q7AM0031 设备号
起始时间   start 是   String 略   搜索黑白图的开始时间戳(包含当前时间戳)
结束时间   end 是   String 略   搜索黑白图的结束时间戳(包含当前时间戳)

Response

字段名 变量名 类型  示例值 描述 
图像信息   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 略   相机拼接参数
黑白图数据列表   data Array 略   黑白图数据列表  
data.$.timestamp String 1513521818885 时间戳
data.$.oss String https://camsgear-imagecams-bw-demo.oss-cn-hangzhou.aliyuncs.com/5a3659db8f0dcf25fe4ddc98/PDS11Q7AM0196/20171217/22/0043.jpg 图片地址  

管理员(Developer) 通用API

登陆

HTTP Request

POST https://api.camsgear.com/developer/auth/signin

Body

字段名 变量名 必填  类型  示例值 描述 
用户名 username 是   String 略   邮箱或手机号
密码  password 是   String 略   密码 

Response

字段名 变量名 类型  示例值 描述 
开发者token authorization String 略   开发者token

登出

HTTP Request

GET https://api.camsgear.com/developer/auth/signout

Headers

字段名 变量名 必填  类型  示例值 描述 
开发者token authorization 是   String 略   开发者token

Response

字段名 变量名 类型  示例值 描述 
登出状态   success Boolean true 登出状态  

获取应用列表

HTTP Request

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

Headers

字段名 变量名 必填  类型  示例值 描述 
开发者token authorization 是   String 略   开发者token

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
应用列表   data Array 略   数组 
data.$.id String 略   略  
data.$.appID String lP0Zn8Dc1Xu5knDx 应用key 
data.$.appSecret String 略   应用秘钥  
data.$.name String 中咖助手   应用名

获取人数统计分组列表

HTTP Request

GET https://api.camsgear.com/developer/algorithm/countint/schenes

Headers

字段名 变量名 必填  类型  示例值 描述 
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   应用ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
分组列表   data Array 略   数组 
data.$.id String 略   分组ID 
data.$.name String 略   分组名

获取人数统计分组数据

HTTP Request

GET https://api.camsgear.com/developer/algorithm/counting/schenes/5a7c41970c97bb06ce5c2bd5/data

Headers

字段名 变量名 必填  类型  示例值 描述 
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
查询数据开始时间戳 start 是   String 1518105600000 数据开始时间戳(13位) 
查询数据结束时间戳 end 是   String 1518192000000 查询数据结束时间戳(13位)  

Response

字段名 变量名 类型  示例值 描述 
分组数据   data Array 略   数组 
data.$.name String PDS11Q79K0022 设备序列号 
data.$.data Array [[1518170073000,3],[1518170135000,3],[1518170203000,2]] 例如: [[时间戳1, 人数1], [[时间戳2, 人数2] ...]]

管理员(Developer) 人脸识别-地区

地区列表

HTTP Request

GET https://api.camsgear.com/developer/facedetection/region

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
地区列表   data Array 略   数组 
data.$.id String 略   地区ID 
data.$.name String 上海  地区名

添加地区

HTTP Request

POST https://api.camsgear.com/developer/facedetection/region

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Body

字段名 变量名 必填  类型  示例值 描述 
地区名 name 是   String 上海  略  

Response

字段名 变量名 类型  示例值 描述 
地区ID  id String 略   当前应用下的地区ID 
地区名 name String 上海  略  

修改地区

HTTP Request

PATCH https://api.camsgear.com/developer/facedetection/region/:regionId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
地区ID  regionId 是   String 略   创建时返回的ID

Body

字段名 变量名 必填  类型  示例值 描述 
地区名 name 是   String 上海  略  

Response

字段名 变量名 类型  示例值 描述 
修改状态   success Boolean true 是否修改成功状态 

删除地区

注: 删除地区将会删除所有该地区下的用户以及识别记录!

HTTP Request

DELETE https://api.camsgear.com/developer/facedetection/region/:regionId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
地区ID  regionId 是   String 略   创建时返回的ID

Response

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

管理员(Developer) 人脸识别-用户类型

用户类型列表

HTTP Request

GET https://api.camsgear.com/developer/facedetection/usercategory

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
用户类型列表 data Array 略   数组 
id String 略   用户类型ID  
name String VIP 用户类型名 
isNotice Boolean false 识别是否推送,保留字段. 默认false
noticeInterval Number 86400 识别推送间隔, 默认86400秒

添加用户类型

HTTP Request

POST https://api.camsgear.com/developer/facedetection/usercategory

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Body

字段名 变量名 必填  类型  示例值 描述 
用户类型名  name 是   String VIP 略  
识别是否推送 isNotice 否   Boolean 略   保留字段  
识别推送间隔 noticeInterval 否   Number 略   保留字段  

Response

字段名 变量名 类型  示例值 描述 
用户类型ID   id String 略   当前应用下的用户类型ID  
用户类型名  name String VIP 略  
识别是否推送 isNotice Boolean 略   保留字段  
识别推送间隔 noticeInterval Number 略   保留字段  

修改用户类型

HTTP Request

PATCH https://api.camsgear.com/developer/facedetection/usercategory/:categoryId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
用户类型ID   categoryId 是   String 略   创建时返回的ID

Body

字段名 变量名 必填  类型  示例值 描述 
用户类型名  name 否   String VIP 略  
识别是否推送 isNotice 否   Boolean 略   保留字段  
识别推送间隔 noticeInterval 否   Number 略   保留字段  

Response

字段名 变量名 类型  示例值 描述 
修改状态   success Boolean true 是否修改成功状态 

删除用户类型

注: 删除用户类型将会删除所有该用户类型的用户以及识别记录!

HTTP Request

DELETE https://api.camsgear.com/developer/facedetection/usercategory/:categoryId

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
用户类型ID   categoryId 是   String 略   创建时返回的ID

Response

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

管理员(Developer) 人脸识别-设备

获取设备列表

HTTP Request

GET http://localhost:5001/developer/facedetection/device/list

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
设备号 deviceNumber 否   String 略   支持模糊查找
地区ID  regionId 否   String 略   精确查找  

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
设备列表   data Array 略   数组 
data.$.deviceNumber String 略   设备号
data.$.region Object 略   地区信息,若创建时为添加地区ID,则不返回该字段 
data.$.region.id String 略   略  
data.$.region.name String 上海  略  

绑定设备

HTTP Request

POST https://api.camsgear.com/developer/facedetection/device/bind

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Body

字段名 变量名 必填  类型  示例值 描述 
设备号 deviceNumber 是   String 略   略  
地区ID  regionId 否   String 略   允许先绑定后设置地区  

Response

字段名 变量名 类型  示例值 描述 
绑定状态   success Boolean true 略  

解绑设备

HTTP Request

POST https://api.camsgear.com/developer/facedetection/device/unbind

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Body

字段名 变量名 必填  类型  示例值 描述 
设备号 deviceNumber 是   String 略   略  

Response

字段名 变量名 类型  示例值 描述 
解绑状态   success Boolean true 略  

管理员(Developer) 人脸识别-用户

用户列表

HTTP Request

GET https://api.camsgear.com/developer/facedetection/user

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
用户ID  id 否   String 略   精确查找用户ID
用户描述   description 否   String 略   模糊查询用户描述 
地区ID  regionId 否   String 略   精确查找地区ID
用户类型ID   categoryId 否   String 略   精确查找用户类型ID 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
用户列表   data Array 略   数组 
data.$.id String 略   用户ID 
data.$.description String 略   用户描述  
data.$.custom String 略   自定义参数,JSON字符串 
data.$.photo String 略   用户照片url  
data.$.region Object 略   地区信息  
data.$.region.id String 略   地区ID 
data.$.region.name String 上海  地区名
data.$.category Object 略   用户类型信息
data.$.category.id String 略   用户类型ID  
data.$.category.name String VIP 用户类型名 

创建用户

HTTP Request

POST https://api.camsgear.com/developer/facedetection/user

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Body

字段名 变量名 必填  类型  示例值 描述 
用户描述   description 否   String 略   标识用户  
地区ID  regionId 是   String 略   略  
用户类型ID   categoryId 是   String 略   略  
自定义参数  custom 否   String 略   用户自定义参数,JSONString格式

Response

字段名 变量名 类型  示例值 描述 
用户ID  id String 略   略  
应用ID  appID String 略   略  
用户描述   description String 略   略  
自定义参数  custom String 略   JSON字符串
地区信息   region Object 略   略  
地区ID  region.id String 略   略  
地区名 region.name String 上海  略  
用户类型信息 category Object 略   略  
用户类型ID   category.id String 略   略  
用户类型名  category.name String VIP 略  
创建时间   createdAt String 略   略  
更新时间   createdAt String 略   略  

更新用户

HTTP Request

PATCH https://api.camsgear.com/developer/facedetection/user/:userId

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
用户ID  userId 是   String 略   创建时返回的ID

Body

字段名 变量名 必填  类型  示例值 描述 
用户描述   description 否   String 略   标识用户  
地区ID  regionId 否   String 略   略  
用户类型ID   categoryId 否   String 略   略  
自定义参数  custom 否   String 略   用户自定义参数,JSONString格式

Response

字段名 变量名 类型  示例值 描述 
修改状态   success Boolean true 是否修改成功状态 

删除用户

注: 删除用户类型将会删除所有该用户的识别记录!

HTTP Request

DELETE https://api.camsgear.com/developer/facedetection/user/:userId

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
用户ID  userId 是   String 略   创建时返回的ID

Response

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

管理员(Developer) 人脸识别-OSS

获取上传照片/特征文件Token接口

HTTP Request

GET https://api.camsgear.com/developer/facedetection/origin/upload/token

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
类型  type 是   String photo ['photo', 'feature']

Response

字段名 变量名 类型  示例值 描述 
上传前缀路径 path String 略   只是前缀,上传时需要添加文件路径
上传ID  accessKeyId String 略   略  
上传url  host String 略   略  
上传策略   policy String 略   略  
上传签名   signature String 略   略  

获取上传识别图片Token接口(客户端设备)

HTTP Request

GET https://api.camsgear.com/developer/facedetection/record/upload/token

Headers

字段名 变量名 必填  类型  示例值 描述 
设备编号   deviceNumber 是   String 略   略  
签名  signature 是   String 略   略  

Response

字段名 变量名 类型  示例值 描述 
上传前缀路径 path String 略   只是前缀,上传时需要添加文件路径
上传ID  accessKeyId String 略   略  
上传url  host String 略   略  
上传策略   policy String 略   略  
上传签名   signature String 略   略  

获取下载特征文件STS Token接口(客户端设备)

HTTP Request

GET https://api.camsgear.com/developer/facedetection/origin/download/token

Headers

字段名 变量名 必填  类型  示例值 描述 
设备编号   deviceNumber 是   String 略   略  
签名  signature 是   String 略   略  

Response

字段名 变量名 类型  示例值 描述 
OSS节点  region String oss-cn-hangzhou 略  
文件所在bucket   bucket String camsgear-f1-demo 略  
STS访问ID  AccessKeyId String 略   略  
STS访问秘钥   AccessKeySecret String 略   略  
临时请求token   SecurityToken String 略   略  
过期时间   Expiration String 2018-05-11T09:27:11Z 略  

管理员(Developer) 人脸识别-识别结果

获取识别结果列表

HTTP Request

GET https://api.camsgear.com/developer/facedetection/record/history

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   开发者token

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
记录ID  id 否   String 略   精确查找识别记录ID 
用户ID  userId 否   String 略   精确查找用户ID
地区ID  regionId 否   String 略   精确查找地区ID
用户类型ID   categoryId 否   String 略   精确查找用户类型ID 
起始时间戳  start 否   String 略   搜索开始时间戳,精确到毫秒(13位)  
结束时间戳  end 否   String 略   搜索结束时间戳,精确到毫秒(13位)  

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
识别记录列表 data Array 略   数组 
data.$.id String 略   记录ID 
data.$.user Object 略   用户信息  
data.$.user.id String 略   用户ID 
data.$.user.description String 略   用户描述  
data.$.user.custom String 略   用户自定义参数,JSONString  
data.$.region Object 略   地区信息  
data.$.region.id String 略   地区ID 
data.$.region.name String 上海  地区名
data.$.category Object 略   用户类型信息
data.$.category.id String 略   用户类型ID  
data.$.category.name String 略   用户类型名 
data.$.timestamp String 略   识别时间戳 
data.$.avatar String 略   识别头像Url  

管理员(Developer) 人脸识别-其他

获取特征文件更新列表(客户端设备)

HTTP Request

GET https://api.camsgear.com/developer/facedetection/feature/check

Headers

字段名 变量名 必填  类型  示例值 描述 
设备编号   deviceNumber 是   String 略   略  
签名  signature 是   String 略   略  

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
最后更新时间戳   timestamp 否   String 略   精确到毫秒(13位)

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
特征文件列表 data Array 略   数组 
data.$.id String 略   用户ID 
data.$.appID String 略   应用ID 
data.$.featurePath String 略   特征文件oss路径
data.$.featureUpdatedAt String 略   特征文件更新时间 

特征文件生成异常通知(AI Engine)

HTTP Request

POST https://api.camsgear.com/developer/facedetection/feature/failure

Headers

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

Body

字段名 变量名 必填  类型  示例值 描述 
用户ID  userId 是   String 略   略  

Response

字段名 变量名 类型  示例值 描述 
字段名 变量名 类型  示例值 描述 
:--------- :------ :------ :---- :--------------
请求状态   success Boolean true 略  

管理员(Developer) Heatmap Config 模块

创建热区

创建Heatmap

HTTP Request

POST https://api.camsgear.com/v1/heatmap

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.$.sceneBases Array 略   场景底图列表
场景底图名称 scenes.$.sceneBases.$.name String 实景图/线框图 场景底图  
场景底图地址 scenes.$.sceneBases.$.source String http://xxxx.jpg 场景底图地址
场景底图是否为默认 scenes.$.sceneBases.$.isDefault Boolean True 是否为默认底图  
设备列表   scenes.$.devices Array 略   场景包含的设备列表
设备列表   scenes.$.devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

获取热区列表

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

HTTP Request

GET https://api.camsgear.com/v1/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.$.sceneBases Array 略   场景底图列表
场景底图名称 data.$.scenes.$.sceneBases.$.name String 实景图/线框图 场景底图  
场景底图地址 data.$.scenes.$.sceneBases.$.source String http://xxxx.jpg 场景底图地址
场景底图是否为默认 data.$.scenes.$.sceneBases.$.isDefault Boolean True 是否为默认底图  
设备列表   data.$.scenes.$.devices Array 略   场景包含的设备列表
设备列表   data.$.scenes.$.devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

获取单个热区详情

通过热区ID获取热区详情

HTTP Request

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

Headers

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

URL Parameters

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

Response

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

删除热区

根据热区ID删除热区,删除热区会将所有热区关联的场景,设备及相应数据统一删除

HTTP Request

DELETE https://api.camsgear.com/v1/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/v1/heatmaps/:heatmapId/scene

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 唯一标识一个热区场景  
所在热区ID   id String 5a28e437105d00b4ff3b7683 唯一标识一个热区 
场景名称   name String 乐贝家全店  场景名称  
场景底图列表 sceneBases Array 略   场景底图列表
场景底图名称 sceneBases.$.name String 实景图/线框图 场景底图  
场景底图地址 sceneBases.$.source String http://xxxx.jpg 场景底图地址
场景底图是否为默认 sceneBases.$.isDefault Boolean True 是否为默认底图  
设备列表   devices Array 略   场景包含的设备列表
设备列表   devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

上传场景底图

HTTP Request

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

Headers

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

URL Parameters

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

Body

字段名 变量名 必填  类型  示例值 描述 
图片  image 否   Image 略   底图 

Response

字段名 变量名 类型  示例值 描述 
场景ID  id String 5a28e437105d00b4ff3b7682 唯一标识一个热区场景  
所在热区ID   id String 5a28e437105d00b4ff3b7683 唯一标识一个热区 
场景名称   name String 乐贝家全店  场景名称  
场景底图列表 sceneBases Array 略   场景底图列表
场景底图名称 sceneBases.$.name String 实景图/线框图 场景底图  
场景底图地址 sceneBases.$.source String http://xxxx.jpg 场景底图地址
场景底图是否为默认 sceneBases.$.isDefault Boolean True 是否为默认底图  
设备列表   devices Array 略   场景包含的设备列表
设备列表   devices.$.serialNumber String PDS11Q79K0047 场景包含的设备序列号  

创建场景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 是否删除成功

管理员(Developer) Heatmap Data 模块

创建热区数据分析事件

创建Heatmap Data Event

HTTP Request

POST https://api.camsgear.com/v1/heatmaps/:heatmapId/event

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/v1/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 略   s

删除热区分析事件

删除热区分析事件

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 数据 

管理员(Developer) Human Traffic

获取license列表

HTTP Request

GET https://api.camsgear.com/developer/humantraffic/license

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   token与签名必须传其中一个  
签名  signature 是   String 略   token与签名必须传其中一个  

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
license列表  data Array 略   数组 
data.$.license String 略   略  
data.$.isTrial Boolean true 是否为试用账号  
data.$.status String stop 当前状态,可能为空 

获取license详情

HTTP Request

GET https://api.camsgear.com/developer/humantraffic/license/:license

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   token与签名必须传其中一个  
签名  signature 是   String 略   token与签名必须传其中一个  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  

Response

字段名 变量名 类型  示例值 描述 
license license String 略   略  
是否为试用账号   isTrial Boolean true
状态  status String stop 当前状态,可能为空 

修改license信息

HTTP Request

PATCH https://api.camsgear.com/developer/humantraffic/license/:license

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   token与签名必须传其中一个  
签名  signature 是   String 略   token与签名必须传其中一个  

Body

字段名 变量名 必填  类型  示例值 描述 
是否为试用账号   isTrial 否   Boolean false 可切换账号为正式账号(取消试用限制)  
状态  status 否   String stop 可以修改license的状态  

Response

字段名 变量名 类型  示例值 描述 
是否修改成  success Boolean true 略  

获取license数据

HTTP Request

GET https://api.camsgear.com/developer/humantraffic/license/:license/data

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
开发者token authorization 是   String 略   token与签名必须传其中一个  
签名  signature 是   String 略   token与签名必须传其中一个  

URL Parameters

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
开始时间戳  start 是   String 略   查询数据开始时间戳(13位,精确到毫秒)
结束时间戳  end 是   String 略   查询数据结束时间戳(13位,精确到毫秒)
聚合间隔   interval 是   String 15m 可选[ '15m', '30m', '1h', 'total' ],其中total为统计总数

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
license统计数据列表 data Array 略   数组 
data.$.timestamp String 略   统计时刻时间戳  
data.$.count Number 略   统计时刻人流数  

用户(User) Human Traffic

开始人流统计

HTTP Request

POST https://api.camsgear.com/v1/humantraffic/start

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
授权签名   policy-signature 是   String 略   告知CamsgearKit API用户授权信息 

Body

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  
时间戳 timestamp 否   String 略   指定开始时间戳  

Response

字段名 变量名 类型  示例值 描述 
安全验证签名 stsSignature String 略   包含过期时间、授权信息的签名,用于App推送人流数据验证用  

结束人流统计

HTTP Request

POST https://api.camsgear.com/v1/humantraffic/stop

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
授权签名   policy-signature 是   String 略   告知CamsgearKit API用户授权信息 

Body

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  
时间戳 timestamp 否   String 略   指定结束时间戳  

Response

字段名 变量名 类型  示例值 描述 
是否成功关闭 success Boolean true 略  

获取人流数据统计结果

HTTP Request

GET https://api.camsgear.com/v1/humantraffic/data

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
授权签名   policy-signature 是   String 略   告知CamsgearKit API用户授权信息 

Query Parameters

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  
开始时间戳  start 是   String 略   查询数据开始时间戳(13位,精确到毫秒)
结束时间戳  end 是   String 略   查询数据结束时间戳(13位,精确到毫秒)
聚合间隔   interval 是   String 15m 可选[ '15m', '30m', '1h' ] 

Response

字段名 变量名 类型  示例值 描述 
总记录条数  total Int 10 所有记录条数
跳过的记录条数   skip Int 0 跳过的记录条数  
license统计数据列表 data Array 略   数组 
data.$.timestamp String 略   统计时刻时间戳  
data.$.count Number 略   统计时刻人流数  

上报人流统计数据

HTTP Request

POST https://api.camsgear.com/v1/humantraffic/report

Headers

字段名 变量名 必填  类型  示例值 描述 
应用ID  appID 是   String 略   分配的appID
安全验证签名 sts-signature 是   String 略   由调用开始人流统计接口返回  

Body

字段名 变量名 必填  类型  示例值 描述 
license license 是   String 略   略  
统计时间戳  timestamp 是   String 略   时间戳(13位,精确到毫秒)
人流数量   count 是   Number 略   统计的数量 

Response

字段名 变量名 类型  示例值 描述 
是否上报成功 success Boolean true 略