SDK 参考

每一个 Keyda SDK（Android、iOS、React Native、Flutter、Ionic）都实现相同的精简协议。如果你用过其中一个，你就都会用了。

API

刻意不提供其他功能。没有消息发送 API，没有未读计数，没有用户身份调用——因为这些功能目前都无法端到端运行，而一个无法正常使用的方法比缺少该方法还要糟糕。

每个 SDK 打开的 URL

{baseUrl}/chat/{clientId}

baseUrl 默认为 https://keyda.in/business，且可在每个平台上进行覆盖，用于测试环境或自托管安装。

为什么使用网页视图，以及它会给您带来什么成本

只有一个由平台提供的聊天界面，所有界面都会加载它。

您将获得：店主在控制面板中所做的更改（强调色、欢迎语、机器人名称、上线状态）会立即同步到所有应用，无需发布。修复会同时在各处生效。跨平台的聊天体验完全一致。

费用说明：聊天需要保持连接。目前没有离线模式，也没有推送通知。

我们宁愿您在上线前就知道这一点，而不是事后才发现。

每个 SDK 作出的保证

1. 导航跳转。 指向任何其他来源的链接都会在系统浏览器中打开，而不会替换聊天界面。如果没有这个功能，点击一下页脚链接就会结束客户的对话且无法返回。
2. 对话保持。已启用 DOM 存储，因此客户关闭应用后再次打开，仍可查看 24 小时内的历史对话。
3. 键盘绝不会遮挡输入框。
4. 安全区域受到尊重 — 聊天窗口不会绘制在刘海屏或主屏幕指示条下方。
5. 任何崩溃都不会波及你的应用。 加载失败时会显示重试按钮。
6. 无分析、无设备标识符、无第三方依赖。添加Keyda SDK不会为您的应用添加任何追踪器。

Client id 格式

kb_live_ followed by 8-48 hexadecimal characters

其他任何内容都会在初始化时被拒绝，而不是在客户面前打开一个 404 页面。客户端 ID（client id）按设计是公开的——它在任何嵌入该小组件的网站中都可见——并且不具备读取或更改您账户权限的能力。请参阅限制与安全性。

来源

公开且采用 MIT 许可证：github.com/KeydaAI/keyda-business-sdks。所有软件包都必须遵守的共享契约位于该仓库顶部的 CONTRACT.md 中。