第三方设备接入API规范
更新时间：2024-11-14
设备管理接口
设备接入ibs的设备管理接口包含可以获取设备状态的相关接口
获取设备状态
接口描述
本接口用于ibs从设备方获取设备状态。
请求路径
| Path | Method | 说明 |
|---|---|---|
| /v1/device | GET | 获取设备状态 |
请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| systemId | String | 否 | 设备方的设备系统id |
响应头域
除公共头域外，无其它特殊头域。
响应体
| 参数名称 | 类型 | 描述 |
|---|---|---|
| deviceList | List |
设备列表 |
| +systemId | String | 设备方的设备系统id |
| +state | String | 设备状态 |
请求示例
Plain Text
1GET http://xxxxx/v1/device
2Host: {host}
3Content-type: application/json
4Authorization: {authorization string}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3
4{
5 "deviceList":[
6 {
7 "systemId":"aaaaaa1",
8 "state":"online"
9 },
10 {
11 "systemId":"aaaaaa2",
12 "state":"offline"
13 }
14 ]
15}赛事管理接口
设备接入ibs的赛事管理接口包含预定赛事、更新赛事、删除赛事等接口。
预定赛事
接口描述
本接口用于ibs向设备方发送预定赛事的请求
请求路径
| Path | Method | 说明 |
|---|---|---|
| /v1/event/create | POST | 预定赛事 |
请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| systemId | String | 是 | 设备方的设备系统id |
| startTime | String | 是 | 赛事开始时间 |
| endTime | String | 是 | 赛事结束时间 |
| streamURL | String | 是 | 设备推流地址 |
响应头域
除公共头域外，无其它特殊头域。
响应体
| 参数名称 | 类型 | 描述 |
|---|---|---|
| eventId | String | 设备方的赛事id，用于后面更新等操作 |
请求示例
Plain Text
1POST http://xxxxx/v1/event/create
2Host: {host}
3Content-type: application/json
4Authorization: {authorization string}
5
6{
7 "systemId":"device1999",
8 "startTime":"1706611200",
9 "endTime":"1706618068",
10 "streamURL":"rtmp://xxxx/xxx/xxx/xxx"
11 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3
4{
5 "eventId":"xxxxxx"
6}更新赛事
接口描述
本接口用于ibs向设备方发送更新赛事的请求
请求路径
| Path | Method | 说明 |
|---|---|---|
| /v1/event/update | POST | 更新赛事 |
请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| eventId | String | 是 | 设备方赛事id |
| startTime | String | 否 | 赛事开始时间 |
| endTime | String | 否 | 赛事结束时间 |
| streamURL | String | 否 | 设备推流地址 |
响应头域
除公共头域外，无其它特殊头域。
请求示例
Plain Text
1POST http://xxxxx/v1/event/update
2Host: {host}
3Content-type: application/json
4Authorization: {authorization string}
5{
6 "startTime":"1706611200",
7 "endTime":"1706618068",
8 "eventId":"xxxxxx"
9 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8删除赛事
接口描述
本接口用于ibs向设备方发送删除已预定赛事的请求
请求路径
| Path | Method | 说明 |
|---|---|---|
| /v1/event/delete | POST | 删除赛事 |
请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| eventId | String | 是 | 设备方的赛事id |
响应头域
除公共头域外，无其它特殊头域。
请求示例
Plain Text
1POST http://xxxxx/v1/event/delete
2Host: {host}
3Content-type: application/json
4Authorization: {authorization string}
5
6{
7 "eventId":"xxxxxx"
8 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8