SDK 參考
每一個 Keyda SDK——Android、iOS、React Native、Flutter、Ionic——都實作了相同的簡短合約。如果您用過其中一個,就等於全部都會用。
API
| 通話 | 它的功能 |
|---|---|
init / initialize | 儲存您的 client id。進行驗證,若格式不正確則會明確報錯。 |
show | 在您的應用程式上方呈現聊天介面。 |
dismiss | 關閉它。 |
isShowing | 目前是否正處於呈現狀態。 |
刻意沒有其他功能。沒有訊息發送 API、沒有未讀計數、沒有使用者身分呼叫——因為這些功能目前都無法端對端運作,而一個無法運作的方法比沒有方法更糟。
每個 SDK 開啟的 URL
{baseUrl}/chat/{clientId}baseUrl 預設為 https://keyda.in/business,且可在所有平台上覆寫,適用於測試環境或自行主機託管安裝。
為什麼使用網頁檢視(web view),以及它對您的影響
只有一個由平台提供的聊天介面,每個管道都會載入它。
您將獲得: 業主在儀表板中所做的任何變更(主色調、歡迎訊息、機器人名稱、上線)都會立即同步至所有應用程式,無需重新發布。修復會同時生效於各處。跨平台的聊天體驗完全相同。
費用說明:聊天功能需要連線。目前沒有離線模式,也沒有推播通知。
我們寧願您在發布前就知道這一點,而不是事後才發現。
各 SDK 所提供的保證
- 導覽跳脫。 連往任何其他來源的連結會在系統瀏覽器中開啟,而不是取代聊天。沒有這個功能,只要輕觸一下頁腳連結就會結束客戶的對話,且無法返回。
- 對話連續性。已啟用 DOM 儲存,因此關閉應用程式後再次返回的客戶可以繼續之前的對話串(持續 24 小時)。
- 鍵盤絕不會遮擋輸入框。
- 尊重安全區域 — 聊天視窗不會顯示在瀏海或主畫面指示器下方。
- 任何崩潰都不會影響你的應用程式。 載入失敗時會顯示重試按鈕。
- 沒有分析、沒有裝置識別碼、沒有第三方相依性。新增 Keyda SDK 不會在您的應用程式中加入追蹤器。
Client id 格式
kb_live_ followed by 8-48 hexadecimal characters任何其他內容在初始化時就會遭到拒絕,而不會在客戶面前開啟 404 頁面。Client ID 依設計就是公開的——它會顯示在任何嵌入該小工具的網站中——並且不具備讀取或修改您帳戶的權限。請參閱限制與安全性。
來源
公開且採用 MIT 授權:github.com/KeydaAI/keyda-business-sdks. 每個套件都必須遵守的共用協定位於該儲存庫頂端的 CONTRACT.md 中。