- 必捷BJ62S/BJ66/MNG8000标准版提供完整的HTTP REST API接口,开发者可基于API实现设备状态查询、远程会议控制、投屏会话管理、用户鉴权、审计日志拉取等深度对接
- 鉴权方式:Basic Auth(设备本地API)+ Bearer Token(MNG8000管理平台),两种方式互不冲突,按场景灵活选择
- 核心业务接口覆盖设备信息、会话控制、用户管理、审计日志、Webhook回调5大类,每类提供完整的请求/响应字段定义
- API与SDK深度联动:HTTP API 用于管理,SDK 用于实时投屏控制,二者可独立使用也可组合使用
- 本文提供 Python + Java 双语言示例代码,覆盖鉴权、设备控制、会议触发、审计日志拉取 4 个常用场景
必捷API体系架构
必捷API分为两层架构:设备层API(运行在BJ62S/BJ66终端本机,提供投屏/会议控制接口)和管理平台API(运行在MNG8000,提供多设备集中管理接口)。两层API风格统一,均基于HTTP/HTTPS + JSON,遵循RESTful规范。
设备层API
运行在BJ62S/BJ66终端本机(默认监听 http://设备IP:8080),适用于单设备直接控制场景,例如企业自研会议助手集成、设备调试、自动化测试。鉴权采用 HTTP Basic Auth(用户名/密码为设备后台账号)。
管理平台API
运行在MNG8000统一管理平台(默认监听 https://平台IP:8443),适用于多设备集中管理场景,例如集团IT运维系统、BI平台对接、第三方运维监控集成。鉴权采用 OAuth 2.0 风格的 Bearer Token,需先调用 /api/v1/auth/token 获取 Token。
| 维度 | 设备层API | 管理平台API |
|---|---|---|
| 部署位置 | BJ62S/BJ66 终端本机 | MNG8000 管理平台 |
| 默认端口 | 8080 (HTTP) | 8443 (HTTPS) |
| 鉴权方式 | HTTP Basic Auth | Bearer Token (OAuth 2.0) |
| 适用场景 | 单设备直接控制 | 多设备集中管理 |
| 典型调用方 | 企业自研会议助手、自动化测试 | 集团IT运维、BI平台 |
| 并发能力 | 单设备 50 QPS | 平台级 5000+ QPS |
| 审计日志 | 本地存储 90 天 | 中心存储 ≥ 1 年 |
鉴权流程详解
两种API鉴权方式流程差异较大,下面分别展开。
设备层API – Basic Auth
Basic Auth 是 HTTP 协议内置的最基础鉴权方式,调用方需在请求头携带 Authorization: Basic base64(username:password) 即可发起请求,无需先获取 Token。优势是简单直接,缺点是每次请求都需携带完整凭据。
- 在 BJ62S/BJ66 后台 → 系统设置 → API访问 中启用”API远程访问”
- 设置 API 用户名(建议专用账号,与后台账号分离)与强密码
- 客户端按 HTTP Basic Auth 规则构造请求头,发起业务请求
- 设备返回 JSON 格式业务数据,状态码遵循 HTTP 标准(200/401/403/500)
管理平台API – Bearer Token
MNG8000 采用 OAuth 2.0 风格的 Token 鉴权,调用方先调用 Token 接口获取 Access Token,后续用 Authorization: Bearer {token} 头调用业务接口。Token 默认有效期 7200 秒,过期前需用 Refresh Token 刷新。
- POST /api/v1/auth/token 携带 client_id + client_secret 获取 Access Token + Refresh Token
- 业务接口请求头携带 Authorization: Bearer {access_token}
- Token 即将过期时(建议过期前 5 分钟)调用 POST /api/v1/auth/refresh 刷新
- Refresh Token 也过期则需重新走步骤 1
核心业务接口清单
必捷API按业务域划分为5大类,每类提供完整的CRUD接口。下面列出每个业务域的核心接口与典型用途。
| 业务域 | 核心接口 | 用途 |
|---|---|---|
| 设备信息 | GET /api/v1/devices | 查询平台下所有设备状态 |
| 设备信息 | GET /api/v1/devices/{id} | 查询单个设备详情 |
| 会话控制 | POST /api/v1/sessions | 创建投屏会话(可指定设备/投屏码/用户) |
| 会话控制 | DELETE /api/v1/sessions/{id} | 强制结束投屏会话 |
| 用户管理 | POST /api/v1/users | 创建企业用户(绑定组织/角色) |
| 用户管理 | GET /api/v1/users/{id}/devices | 查询用户已绑定的设备 |
| 审计日志 | GET /api/v1/audit-logs | 查询审计日志(时间范围/用户/设备过滤) |
| 审计日志 | POST /api/v1/audit-logs/export | 导出审计日志(CSV/JSON) |
| Webhook回调 | POST /api/v1/webhooks | 注册事件订阅(设备上下线/投屏开始结束) |
| Webhook回调 | GET /api/v1/webhooks/events | 查询已触发的事件列表 |
完整接口字段定义与示例请参考必捷互联开放平台官方文档 /news/company/bjcast-sdk-compliance。
Python + Java 双语言示例
Python 示例:拉取设备列表
以下 Python 示例演示如何调用管理平台 API 拉取设备列表:
import requests
PLATFORM = "https://platform.bijienetworks.com:8443"
CLIENT_ID = "your_client_id"
CLIENT_SECRET = "your_client_secret"
# 1. 获取 Access Token
token_resp = requests.post(
f"{PLATFORM}/api/v1/auth/token",
json={"client_id": CLIENT_ID, "client_secret": CLIENT_SECRET},
timeout=10,
)
token = token_resp.json()["access_token"]
# 2. 拉取设备列表
headers = {"Authorization": f"Bearer {token}"}
devices = requests.get(
f"{PLATFORM}/api/v1/devices",
headers=headers,
params={"status": "online", "page": 1, "page_size": 50},
timeout=10,
).json()
for d in devices["items"]:
print(f"{d['id']} | {d['name']} | {d['ip']} | {d['status']}")
Java 示例:触发远程会议
以下 Java 示例演示如何调用设备层 API 触发远程会议:
import java.net.http.*;
import java.util.Base64;
String deviceIP = "192.168.1.100";
String username = "api_user";
String password = "your_password";
String auth = Base64.getEncoder().encodeToString(
(username + ":" + password).getBytes()
);
HttpClient client = HttpClient.newHttpClient();
HttpRequest req = HttpRequest.newBuilder()
.uri(URI.create("http://" + deviceIP + ":8080/api/v1/meeting/start"))
.header("Authorization", "Basic " + auth)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(
"{\"meeting_id\":\"123456789\",\"platform\":\"tencent_rooms\"}"
))
.build();
HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
System.out.println("Status: " + resp.statusCode());
System.out.println("Body: " + resp.body());
5 类典型集成场景
| 场景 | 集成方式 | 必捷API能力 |
|---|---|---|
| 企业会议助手 | 设备层 API + Webhook | 拉取设备状态、推送会议通知、监听会议结束 |
| 集团 IT 运维 | 管理平台 API | 批量设备上下线、固件升级、配置变更 |
| BI 数据分析 | 管理平台 API + 审计日志导出 | 拉取投屏时长、用户活跃度、设备利用率 |
| 门禁系统联动 | Webhook 事件订阅 | 会议室门禁开启自动唤醒投屏设备 |
| 客服运维台 | 管理平台 API + 设备控制 | 远程查看设备状态、远程重启、远程日志拉取 |
以上 5 类场景覆盖企业自研系统的 90% 集成需求,具体对接方案可联系必捷商务获取《必捷API集成白皮书》。
