REST API

了解如何整合和使用 EngageLab OTP REST API。

EngageLab OTP 服務提供了一組 RESTful API，允許您透過程式設計方式建立範本、發送 OTP 並驗證驗證碼。

請按照以下步驟開始使用 REST API。

建立 API Key

在呼叫任何 EngageLab OTP API 之前，您需要產生一個 API Key 來對您的請求進行身分驗證。

1. 登入 EngageLab 控制台。
2. 進入 OTP 子控制台並選擇您的應用程式。
3. 在左側導覽列中導覽至 API Keys。
4. 點擊 Create API Key 產生新的 dev_key 和 dev_secret。

⚠️ 警告
您的 dev_secret 高度敏感。請務必妥善保管，切勿在用戶端程式碼或公開程式碼庫中外洩。

身分驗證

EngageLab OTP API 使用 HTTP Basic 身分驗證。您必須在所有 API 請求中包含 Authorization 請求頭。

該請求頭是使用您的 dev_key 和 dev_secret 進行 Base64 編碼建構的：

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} 是將您的 dev_key 和 dev_secret 透過冒號（:）連接後進行 Base64 編碼產生的：base64(dev_key:dev_secret)。

有關更多詳細資訊，請參閱 身分驗證 指南。

呼叫 API

獲得 API Key 並了解身分驗證機制後，您就可以開始呼叫 API 了。所有 API 端點都使用基礎 URL https://otp.api.engagelab.cc。

以下是您可以整合的幾個主要 API：

• 驗證碼下發：透過 EngageLab 平台產生驗證碼，並根據您的範本策略進行下發。
• 驗證碼校驗：安全地驗證使用者提交的一次性密碼（驗證碼）。
• 自訂驗證碼下發：如果您希望自己產生驗證碼，可以將預先產生的驗證碼發送給使用者。
• 自訂訊息下發：發送基於自訂範本建立的訊息內容（例如通知或行銷訊息）。
• 範本管理：透過程式設計方式建立、刪除、取得所有的範本列表以及查看範本詳情。
• 回調配置：配置回調地址並使用安全校驗機制接收狀態報告和通知。
• 生命週期狀態回調：透過回調即時接收訊息在發送、送達和驗證等各個生命週期狀態的資料。
• SMPP：使用 SMPP 協定透過 TCP 連線實現高效、可靠的訊息下發和狀態回報。