控制台使用
控制台用于管理开放平台账号下的应用、API Key 和离线设备授权码。
应用管理
应用是 API Key 的归属单元。创建应用时填写:
| 字段 | 说明 |
|---|---|
| 应用名称 | 面向团队或集成项目的展示名称。 |
| 备注 | 可记录部署环境、客户、集成系统或责任人。 |
创建成功后会得到 appId 和 appKey。后续创建 API Key 时需要选择应用。
API Key 管理
创建 API Key 时应确认:
| 项 | 说明 |
|---|---|
| Key 名称 | 建议包含环境和用途,例如 prod-capture-svip。 |
| 授权模式 | online_api_key 用于在线能力,offline_api_key 用于离线能力。 |
| SDK 等级 | vip、svip、svip_plus。 |
| 有效期 | expireDays 为空或小于等于 0 表示不过期;也可指定 expiresAt。 |
| 设备范围 | deviceScope 控制本地 runtime 可访问设备。 |
完整 Key 只展示一次。丢失后不能找回,只能轮换。
轮换与吊销
- 轮换:复制原 Key 的授权模式、等级、设备范围和有效期,生成新 Key,并将旧 Key 置为
REVOKED。 - 吊销:立即使 Key 不可用。客户端应停止当前 session 并清理本地配置。
离线设备授权码
离线授权用于没有公网或需要本地固定机器授权的场景。
- 客户端或 SDK runtime 获取机器码。
- 在控制台输入
machineCode。 - 生成
authorizationCode。 - 在本地通过
auth.activate_offline激活当前会话。
限制:
- 每个开放平台账号最多 2 台不同机器。
- 同一未过期机器码重复提交会返回已有授权码。
- 已过期机器码不允许续期。
- 授权码默认有效 30 天。
以上 2 台机器和 30 天有效期属于开放平台体验测试设备授权策略。如需接入更多设备、用于市场或商业化场景,或调整授权数量和有效期,请联系成者(CZUR)商务人员。
与 SDK runtime 的关系
控制台负责签发和管理凭证;SDK runtime 负责在本地使用凭证。典型链路是:
text
控制台创建 API Key
-> 本地 runtime auth.create_session
-> 按 auth_context.capabilities 和 device_scope 调用能力
-> 在线能力通过网关校验并消耗额度