接入概览

将企业自己的额度与用量系统接入千问办公,让管理员在办公控制台管理成员限额、查看消费统计。

本手册适用于提供“BYOK限额和统计”扩展的 K8S 版本,协议版本为 /spi/v1。安装版本须支持八个接口;文档可读不代表当前安装已开放该能力。

从这里开始

你要做什么阅读内容
第一次对接,确认地址、凭据和用户身份快速开始
提供组织、成员及每日消费数据统计接口
接收成员限额、返回实时组织额度额度接口
检查联调结果或定位失败联调验收与排障

谁调用谁

管理员 → 千问办公控制台 → 千问办公服务 → 企业 SPI 适配服务 → 企业额度与用量系统
                                         ← HTTP 200 + JSON ←

你需要实现右侧的 HTTP 接口。千问办公发起请求,企业服务验证 Token 与组织、执行操作并返回约定的 JSON。浏览器不直接调用企业 SPI。

接入方式调用方向凭据与用途
OpenAPI企业应用 → 千问办公开放平台应用 API Key;调用办公能力
本手册的业务 SPI千问办公 → 企业服务独立 SPI Token;读取统计、设置及读取限额
模型 BYOK千问办公 → 模型 Provider模型配置中的 Endpoint 与可选 API Key;执行模型请求

模型仍在模型管理中单独配置。业务 SPI 不代理模型请求,也不替企业模型完成计量与限额拦截。启用客户额度后,模型请求需要有效的第三方用户身份,企业模型服务应使用同一身份关联消费。

需要实现哪些接口

八个接口共用一个服务地址、Token 和启用开关,不能在控制台分别开启统计或额度。下表“调用时机”说明当前宿主行为;不要仅凭连通性检测通过判断全部接口已完成。

接口名称Method 与路径职责调用时机
获取最新统计日期GET /spi/v1/usage/meta最新完整数据日期统计刷新、手动连通性检测
查询组织用量概览GET /spi/v1/usage/overview组织历史用量按日期和五个周期构建快照
查询成员用量列表GET /spi/v1/usage/members成员历史用量构建快照,读取全部分页
查询成员每日用量趋势GET /spi/v1/usage/members/{external_user_id}/trend成员每日趋势查看成员趋势时按需读取
查询额度规则与周期GET /spi/v1/quota/context额度约束与当前周期校验额度、确定周期边界
查询成员额度POST /spi/v1/quota/users/query已应用的成员额度SDK 显式查询;当前产品不强制写后回读
设置成员限额PUT /spi/v1/quota/users设置单个成员的绝对限额后台派发与重试额度变更
查询组织额度GET /spi/v1/quota/org实时组织总额度与已用量查询组织额度

对接前先约定三个值

值含义本手册的合成示例
组织 ID千问办公组织 UUID;映射到企业账本租户11111111-1111-4111-8111-111111111111
第三方用户 IDIAM 当前已绑定的企业用户标识;保留大小写和前导零employee-1001
计量单位统计用 credit 数字,额度用 minor 整数字符串500 credit = "5000000" minor

示例中的域名、身份和数据仅用于说明。真实联调应使用测试组织、已绑定的测试用户及独立测试凭据。

下一步:准备连接并发起首次请求。