Registration ID 查询功能使用指南

功能概述

regidSearchPath 是 Web Push SDK 提供的一个配置选项，用于自定义 Registration ID 查询页面的访问路径。当用户访问指定的路径时，SDK 会自动弹出一个安全验证弹窗，用户输入正确的 Appkey 后即可查看当前设备的 Registration ID。

PC端：

移动端：

核心特性

• 🔐 安全验证：通过 Appkey 验证确保只有授权用户才能查看 Registration ID
• 📋 一键复制：支持快速复制 Registration ID，方便测试和调试
• 🎨 友好界面：提供美观的弹窗交互界面
• ⚙️ 灵活配置：支持自定义触发路径

配置参数

regidSearchPath

• 类型: string
• 默认值: /engagelab/regid
• 必填: 否
• 说明: 定义触发 Registration ID 查询弹窗的页面路径

使用场景

场景 1：使用默认路径

如果不配置 regidSearchPath，SDK 将使用默认路径 /engagelab/regid。

              
              MTpushInterface.init({
  appkey: 'your-appkey',
  user_str: 'user-identifier',
});

            

访问 https://yourdomain.com/engagelab/regid 即可触发查询弹窗。

场景 2：自定义路径

根据业务需求自定义查询页面路径。

              
              MTpushInterface.init({
  appkey: 'your-appkey',
  user_str: 'user-identifier',
  regidSearchPath: '/admin/push-debug'
});

            

访问 https://yourdomain.com/admin/push-debug 即可触发查询弹窗。

匹配示例

假设配置了 regidSearchPath: '/admin/regid'，以下路径都会触发弹窗：

✅ https://example.com/admin/regid
✅ https://example.com/dashboard/admin/regid
✅ https://example.com/admin/regid?debug=true ✅ https://example.com/#/admin/regid ✅ https://example.com/#/dashboard/admin/regid

注意事项

• 触发时机：弹窗仅在SDK初始化成功后才会展示；
• 路径格式：regidSearchPath为相对路径，仅填写路径部分（如 /admin/regid），不要包含协议、域名或端口；
• 需整页加载：通过地址栏访问对应路径并完成页面刷新时才会检测并弹出；仅在前端路由切换、无整页刷新的情况下不会触发弹窗；
• 集成与初始化：配置的路径必须对应已集成SDK的页面，且该页面已执行初始化并成功，否则不会出现查询弹窗；
• 多页面应用：若为多页面架构，需确保该路径最终打开的HTML页面内引入并初始化了SDK，否则无法触发弹窗；
• 路径匹配：路径匹配通常区分大小写，且会匹配当前URL路径是否包含所配路径（参见上方「匹配示例」）。