AKStream.Next · 文档中心

调用前准备:地址、身份与数据格式

调用前准备:地址、身份与数据格式

接 AKStream.Next API 不需要源码开发环境。准备一个能发 HTTPS 请求、保存秘密并处理 JSON 的服务端程序即可;浏览器需要通过你的后端换取短时票据。

flowchart LR
    A[固定服务器版本] --> B[保存同版本 OpenAPI]
    B --> C[创建最小权限 API Token]
    C --> D[先调用健康和只读接口]
    D --> E[再接异步业务流程]

1. 固定目标版本

先记录部署版本,再保存同版本的 OpenAPI 与 Postman 资产。接口路径、字段和枚举随产品版本演进,不能拿网站最新契约直接调用旧服务器。

2. 确认基础地址

假设平台地址是 https://vms.example.com:

  • 健康检查:GET https://vms.example.com/health
  • 业务 API:https://vms.example.com/api/v2/...
  • 新版 RTC 安全接口:https://vms.example.com/api/v2/rtc/session/...

反向代理必须保留 HTTPS、WebSocket Upgrade、请求体大小、Range 与真实客户端地址语义。

3. 选择正确身份

场景 应使用的身份
人在后台操作 登录会话
后台服务长期集成 独立 API Token
浏览器加入会议 一次性入会票据和短时设备令牌
节点、Agent、内部回调 产品内部服务身份,第三方不用

每套业务系统单独创建 Token,写清用途、负责人、有效期和允许的 IP 范围。不要多人共用管理员 Token。

4. 统一请求规则

  • JSON 使用 UTF-8,时间使用带时区的 ISO 8601。
  • null、空字符串和字段缺失不是同一个意思。
  • 分页从接口声明的默认值开始,不要假设能一次取完全部数据。
  • 客户端忽略新增响应字段,并为未知状态值保留兜底显示。
  • 非 2xx 响应保留原始正文、Content-Type、HTTP 状态和 TraceId。

5. 最小连通性检查

按顺序调用:

  1. /health:确认网络与进程。
  2. /api/v2/system/version:确认实际版本。
  3. /api/v2/auth/me:确认 Token 对应的用户、角色和权限。
  4. 一个只读业务接口:确认你的 Token 能进入目标业务层。

任何一步失败都先停下来修正地址、证书、代理或权限,不要直接进入设备控制和录像任务。