Skip to main content

取得鑒權憑證

取得 HappyOyster 伺服器端與用戶端所需的鑒權憑證：API Host、主 API Key、臨時 API Key、ticket。

關於 HappyOyster 的整體架構，請參見概述。

鑒權憑證

所有介面通過阿里雲百鍊平台閘道鑒權，涉及以下三種憑證：

憑證

使用方

用途

有效期

主 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 Host 與主 API Key 均從百鍊控制台取得，臨時 API Key 與 ticket 由您的伺服器端呼叫介面簽發後下發給用戶端。
主 API Key 僅在伺服器端使用，用戶端 SDK 只使用臨時 API Key，切勿將主 API Key 下發到用戶端或打包進 App 分發。
API Host 與 API Key 必須屬同一業務空間，否則返回 AccessDenied。

1. 取得 API Host

在業務空間管理頁面，複製 API Host 列的內容。伺服器端與用戶端 SDK 都需設定該 API Host。

2. 取得主 API Key

參見取得與設定 API Key。主 API Key 僅存儲在您的伺服器端，不得下發到用戶端或打包進 App 分發。

3. 取得臨時 API Key

伺服器端使用主 API Key 呼叫生成臨時 API Key介面，將返回的臨時 API Key 下發給用戶端 SDK，通過 updateToken 注入。過期後重新生成並再次注入即可，無需重新換取 ticket。

4. 取得 ticket

伺服器端使用主 API Key，根據世界模式呼叫對應的取得體驗憑證介面，取得一次性進房憑證 ticket 後下發給用戶端： ticket 與 Travel 一一綁定，30 分鐘內一次性使用；每次開始新的 Travel 需重新換取。

下一步

  • 接入流程：伺服器端準備世界、下發憑證、取得產物；用戶端 SDK 完成即時體驗。