PAGE1
PAGE1
BISAPI接口开发
1.BISAPI接口概述
BoschBuildingIntegrationSystem（BIS）提供了一系列的API（应用程序接口），称为BISAPI，用于实现与外部系统的集成和二次开发。这些接口允许开发者访问和控制BIS中的各种功能，包括设备管理、事件处理、数据查询等。通过BISAPI，开发者可以构建定制化的解决方案，满足不同应用场景的需求。
1.1BISAPI的主要功能
BISAPI的主要功能包括：
设备管理：添加、删除、修改和查询设备信息。
事件处理：获取和处理设备产生的事件。
数据查询：查询设备状态、历史记录等数据。
用户管理：添加、删除和修改用户信息。
权限管理：设置和管理用户权限。
系统配置：配置系统参数和设置。
1.2BISAPI的访问方式
BISAPI可以通过以下几种方式进行访问：
HTTP/HTTPS：使用HTTP或HTTPS协议进行数据传输。
WebService：通过SOAP或RESTfulWeb服务进行接口调用。
SDK：使用Bosch提供的SDK进行开发。
1.3BISAPI的认证机制
BISAPI采用了严格的认证机制，确保只有授权的用户才能访问系统。常见的认证方式包括：
BasicAuthentication：通过用户名和密码进行认证。
Token-BasedAuthentication：通过APIToken进行认证。
OAuth：使用OAuth协议进行认证。
2.设备管理接口
2.1添加设备
2.1.1接口描述
该接口用于在BIS系统中添加新的设备。需要提供设备的基本信息，如设备类型、设备名称、设备位置等。
2.1.2请求参数
参数名|类型|描述|是否必填|
|————–|———|————————–|———-|
deviceType|string|设备类型|是|
deviceName|string|设备名称|是|
deviceLocation|string|设备位置|是|
deviceSerial|string|设备序列号|否|
2.1.3请求示例
POST/api/v1/devicesHTTP/1.1
Host:
Authorization:Beareryour_api_token
Content-Type:application/json
{
deviceType:Camera,
deviceName:入口摄像头,
deviceLocation:大楼入口,
deviceSerial:1234567890
}
2.1.4响应示例
{
status:success,
message:设备添加成功,
deviceId:d123456
}
2.2删除设备
2.2.1接口描述
该接口用于从BIS系统中删除指定的设备。需要提供设备ID。
2.2.2请求参数
参数名|类型|描述|是否必填|
|——–|——-|————–|———-|
deviceId|string|设备ID|是|
2.2.3请求示例
DELETE/api/v1/devices/d123456HTTP/1.1
Host:
Authorization:Beareryour_api_token
Content-Type:application/json
2.2.4响应示例
{
status:success,
message:设备删除成功
}
2.3修改设备
2.3.1接口描述
该接口用于修改BIS系统中已存在的设备信息。需要提供设备ID和要修改的参数。
2.3.2请求参数
参数名|类型|描述|是否必填|
|————–|———|————————–|———-|
deviceId|string|设备ID|是|
deviceName|string|新的设备名称|否|
deviceLocation|string|新的设备位置|否|
deviceSerial|string|新的设备序列号|否|
2.3.3请求示例
PUT/api/v1/devices/d123456HTTP/1.1
Host:
Authorization:Beareryour_api_token
Content-Type:application/json
{
deviceName:入口摄像头V2,
deviceLocation:大楼正门
}
2.