介面模組使用指南
郵箱身份驗證模組
功能說明
介面字首統一為 http(s)://<your-domain>
生產環境應使用 HTTPS 以保證認證令牌。 HTTP 僅建議用於開發環境。
實現郵箱驗證和密碼重置功能，整合限流和 Turnstile 防護 。支援自動生成隨機密碼和郵件模板定製。在使用者註冊、賬戶繫結等場景中廣泛使用。
🔐 無需鑑權
傳送郵箱驗證郵件
- 介面名稱：傳送郵箱驗證郵件
- HTTP 方法：GET
- 路徑：
/api/verification - 鑑權要求：公開 （限流）
- 功能簡介：傳送郵箱驗證碼到指定郵箱地址，用於郵箱繫結或驗證操作
💡 請求示例：
const response = await fetch(`/api/verification?email=${email}&turnstile=${turnstileToken}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();✅ 成功響應示例：
{
"success": true,
"message": ""
}❗ 失敗響應示例：
{
"success": false,
"message": "無效的引數"
}🧾 欄位說明：
email（字串）: 接收驗證碼的郵箱地址，必須是有效的郵箱格式turnstile（字串）: Turnstile 驗證令牌，用於防止機器人攻擊
傳送重置密碼郵件
- 介面名稱：傳送重置密碼郵件
- HTTP 方法：GET
- 路徑：
/api/reset_password - 鑑權要求：公開 （限流）
- 功能簡介：向已註冊郵箱傳送密碼重置連結，用於使用者找回密碼
💡 請求示例：
const response = await fetch(`/api/reset_password?email=${email}&turnstile=${turnstileToken}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();✅ 成功響應示例：
{
"success": true,
"message": ""
}❗ 失敗響應示例：
{
"success": false,
"message": "該郵箱地址未註冊"
}🧾 欄位說明：
email（字串）: 需要重置密碼的郵箱地址，必須是已註冊的郵箱turnstile（字串）: Turnstile 驗證令牌，用於防止惡意請求
提交重置密碼請求
- 介面名稱：提交重置密碼請求
- HTTP 方法：POST
- 路徑：
/api/user/reset - 鑑權要求：公開
- 功能簡介：透過郵件中的重置連結完成密碼重置，系統會生成新密碼並返回
💡 請求示例：
const response = await fetch('/api/user/reset', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: "user@example.com",
token: "verification_token_from_email"
})
});
const data = await response.json();✅ 成功響應示例：
{
"success": true,
"message": "",
"data": "newPassword123"
}❗ 失敗響應示例：
{
"success": false,
"message": "重置連結非法或已過期"
}🧾 欄位說明：
email（字串）: 要重置密碼的郵箱地址token（字串）: 從重置郵件中獲取的驗證令牌data（字串）: 成功時返回的新密碼，系統自動生成 12 位隨機密碼