SDK 接入概览

SDK 接入概览

本手册面向负责 Entmesh 数据接入的开发者和项目管理员。按本页顺序完成配置后,你应该能够在生产环境发送一条 signup_completed 事件,并在实时事件流中看到它。

最短接入路径

  1. 登录 Entmesh Panel,创建组织和项目。
  2. production 环境配置业务站点 Origin,保存与接入端对应的密钥。
  3. 选择 SDK,初始化并发送测试事件。
  4. 打开“监测 → 实时 → 实时事件流”,核对事件、环境和身份字段。

建议先在 developmentstaging 环境完成联调,验证通过后再替换成 production 密钥。三个环境的数据、来源白名单和密钥相互独立。

已验证版本

平台 文档版本 凭据 Feature Flag / A/B Test
Browser 0.7.0 Browser Key,pk_ 开头 支持决策与曝光
Go 0.6.0 Server Key,sk_ 开头 支持决策与曝光
Android 0.1.1 公开标签 Client Key,ck_ 开头 暂不支持
iOS 公开源码预览,无正式标签 Client Key,ck_ 开头 暂不支持
微信、支付宝、抖音小程序 公开源码预览,无 npm 制品 Client Key,ck_ 开头 暂不支持

iOS 和小程序文章标记为“预览”,接口和发布方式可能变化。生产项目应优先采用有明确版本号的 SDK,并锁定依赖版本。

官方托管地址

用途 地址
分析控制台 https://entmesh.mliev.com
Collector https://collector.entmesh.mliev.com
Browser SDK UMD https://static.1ms.run/entmesh/sdk-js/v0.7.0/entmesh.umd.js
Browser SDK npm Registry https://npm.cnb.cool/mliev/npmjs/-/packages/
Go Module cnb.cool/mliev/entmesh/sdk-go

三类密钥不能混用

密钥 使用位置 是否秘密
pk_… 浏览器页面 公开项目标识,可出现在前端代码中
sk_… Go 服务端 服务端秘密,只能保存在安全的服务端配置中
ck_… Android、iOS、小程序 公共客户端密钥,可随应用发布,但必须登记 Application ID

密钥明文只在项目创建或轮换后的当前页面会话中显示。不要把真实密钥写进工单、截图、日志或公共示例;服务端密钥不要提交到 Git。

完成标准

一次合格的接入应同时满足:

  • 测试事件出现在正确项目和环境的实时事件流中。
  • event_nameproperties、用户或匿名身份符合约定。
  • Browser 来源在允许的 Origin 列表中;移动端和小程序已登记 Application ID。
  • 需要同意管理的应用只在用户授权后采集。
  • 使用实验能力时,真正采用策略后才记录曝光;曝光失败继续使用 fallback。

接下来从左侧目录进入“控制台准备”,然后选择对应平台的 SDK 文章。