Skip to main content

Marketplace

將應用發佈到 Marketplace,其他 Kazzle Space 就能發現並安裝它。

發佈的作用

發佈讓應用可被其他 Space 安裝。使用者會看到應用的名稱、副標題、圖示、發佈者和可見性,然後將其安裝到自己的 Space。發佈需要在 kazzle.config.ts 中設定 subtitle — 應用名稱下方的單行標語。 已發佈版本使用 main 分支上的最新提交。已發佈應用沒有單獨的發行分支。 預設情況下,點擊已發佈應用會開啟其已部署的 UI。應用可選擇設定自訂啟動 URL、要求在開啟前進行 Kazzle 身份驗證,或接收安裝和解除安裝 Webhook。 請參閱發佈應用了解如何發佈應用。

安裝

當有人安裝已發佈應用時,Kazzle 會在其 Space 內建立安裝記錄。安裝 Space 擁有該安裝及其相關資料。

使用者身份

當已登入的 Kazzle 使用者開啟已安裝應用時,Kazzle 會向應用提供目前使用者的資訊。 Kazzle 會附加短期有效的 JWT 作為 Bearer Token。應用可以根據 Kazzle 的公開 JWKS 驗證 Token,以讀取使用者、Space 和安裝資訊。 Token 包含以下聲明: 驗證範例:
應用清單中的兩個欄位控制已發佈應用的啟動行為:
  • kazzleAuthrequired 表示只有已登入的 Kazzle 使用者可以開啟應用;optional 允許在沒有 Kazzle 身份的情況下開啟應用。
  • launchUrl:覆蓋使用者點擊應用時開啟的進入點。

Webhook

如果清單包含 webhookUrl,Kazzle 會在應用安裝或解除安裝時向其發送 HTTP POST 請求。 app.installed 包含發佈者後端可用於向各安裝 API 進行身份驗證的安裝金鑰:
app.uninstalled 包含事件、安裝 ID、應用 ID、Space ID 和 API URL。發佈者應在收到此事件後停止使用安裝金鑰。

各安裝 API

每個安裝都可以呼叫 https://api.kazzle.app 上的限定範圍 API。呼叫可使用安裝金鑰(來自發佈者後端)或使用者身份 Token(來自託管 UI)進行身份驗證。所有操作都會自動限定在該安裝範圍內。 可用端點: 完整的請求和回應結構描述已發佈在 Kazzle OpenAPI 規格中,位址為 https://api.kazzle.app/openapi.json,在以下路徑下。 透過此 API 寫入的密鑰在靜止時加密,並隔離到特定安裝。它們與儲存在 Space 保險庫中的密鑰分開。

後續步驟

  • 發佈應用 — 如何發佈應用及之後會發生什麼。
  • 設定 — 完整清單參考,包括 kazzleAuthlaunchUrlwebhookUrl