為覺城打造自在體驗
覺城上的每個體驗都是獨立的小型網頁應用程式。它在自己的來源網域中，透過沙箱框架執行，並使用精簡的 SDK 與覺城溝通。你可以保留自己的引擎、框架與發布節奏。
整體如何運作
- 平台會在沙箱框架中開啟你的入口網址，並在網址片段中傳入平台本身的來源網域與執行個體 ID。
- 你的程式碼呼叫
connect()。完成簡短交握後，每次呼叫都會透過專用的MessagePort傳送。你的框架不會直接呼叫覺城伺服器。 - 平台會依照核准給你該版本的功能逐一檢查呼叫，再替你儲存、記錄或呈現結果。
SDK 提供的功能
- 訪客的主題設定色彩、淺色或深色模式、字型與減少動態效果設定會以 CSS 變數傳入，並即時更新。
- 安全儲存具版本與修訂編號的儲存欄位，並提供衝突偵測、安全重試與自動儲存。
- 時間計量你回報體驗是否正在執行，由平台計量時間，因此不必自行計時。
- 片刻與徽章讓訪客留下寧靜片刻的照片，並提出由平台驗證的徽章申請。
- 標頭操作可將音效、重新開始、說明與自訂的小型操作放在平台標頭。
- 語言與時間情境資訊會附上訪客的語言與時區，讓你的體驗能用他們熟悉的語言問候。
哪些資訊受到保護
外掛不會收到電子郵件地址、帳號 ID、權杖或 Cookie。情境資訊只包含顯示名稱、語言、時區、會員方案、主題與可選的聲音偏好。框架無法開啟彈出視窗、顯示 alert 對話框、提交表單或導覽頁面。
指南
- 快速入門建立專案、連接測試主機，並儲存第一筆進度。
- 資訊清單與權限宣告你的身分、託管位置與所需功能。
- SDK 參考客戶端 SDK 的所有方法、選項、限制與錯誤碼。
- 生命週期與儲存交握、暫停與繼續、存活回報、修訂編號與重試。
- 託管與審查託管你的體驗、通過審查，並安全發布新版本。
取得 SDK
@zenclub/sdk 是不需額外依賴的 ES 模組套件，並附有 TypeScript 型別。我們會提供給合作創作者。來信聯絡我們分享你的構想，我們會寄上目前版本並安排審查時段。