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 路徑是否包含所設路徑（請參閱上方「匹配範例」）。