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 连接实现高效、可靠的消息下发和状态回报。