跳转到主要内容
快速开始

获取鉴权凭证

获取 HappyOyster 服务端与客户端所需的鉴权凭证:API Host、主 API Key、临时 API Key、ticket。

关于 HappyOyster 的整体架构,请参见概述。

鉴权凭证

所有接口通过千问AI平台网关鉴权,涉及以下三种凭证:

凭证

使用方

用途

有效期

主 API Key

仅服务端

调用所有 Open API(管理世界、换取 ticket、生成临时 API Key、查询产物)

长期

临时 API Key
(SDK 中又称 token)

客户端 SDK

SDK HTTP 层鉴权(通过 updateToken 注入),过期后重新获取并注入即可

默认 1 分钟,最长 30 分钟(通过 expire_in_seconds 配置),需续期

ticket

客户端 SDK

仅用于单次进入房间凭证,由服务端换取后下发给客户端

30 分钟,一次性

凭证流转关系:
  • 主 API Key 仅限服务端持有,客户端永不接触。
  • 服务端用主 API Key 生成临时 API Key 和 ticket,下发给客户端。
  • 客户端通过 updateToken 注入临时 API Key(token)。过期时向您的服务端重新请求并再次注入,无需重新换取 ticket。
  • ticket 为一次性进房凭证,有效期 30 分钟,使用后即失效。每次开始新的 Travel 需重新换取。

获取鉴权凭证

主 API Key 从千问AI平台控制台获取,API Host 固定为 https://maas.qianwenaiapi.com;临时 API Key 与 ticket 由您的服务端调用接口签发后下发给客户端。
仅在本地联调阶段可临时把主 API Key 注入 SDK 跑通流程;一旦对外分发或联调他人客户端,务必改用临时 API Key,切勿将主 API Key 下发到客户端或打包进 App 分发。

1. 确认 API Host

HappyOyster Open API 与客户端 SDK 的 API Host 均为 https://maas.qianwenaiapi.com,无需单独从控制台查找。服务端与客户端 SDK 配置时使用该地址即可。

2. 获取主 API Key

先获取与配置 API Key,再配置 API Key 到环境变量。主 API Key 仅存储在您的服务端,不得下发到客户端或打包进 App 分发。

3. 获取临时 API Key

服务端使用主 API Key 调用生成临时 API Key接口(POST https://maas.qianwenaiapi.com/api/v1/tokens,临时 Key 以 st- 开头、继承主 Key 权限、TTL 1–1800 秒),将返回的临时 API Key 下发给客户端 SDK,通过 updateToken 注入。过期后重新生成并再次注入即可,无需重新换取 ticket。

4. 获取 ticket

服务端使用主 API Key 调用获取体验凭证接口,取得一次性进房凭证 ticket 后下发给客户端: ticket 与 Travel 一一绑定,30 分钟内一次性使用;每次开始新的 Travel 需重新换取。

下一步

  • 接入流程:服务端准备世界、下发凭证、获取产物;客户端 SDK 完成实时体验。
获取鉴权凭证 - 千问AI平台