API Module Guide
Mô-đun xác thực email
Mô tả tính năng
Tiền tố giao diện thống nhất là http(s)://<your-domain>
Nên sử dụng HTTPS trong môi trường sản xuất để bảo mật mã thông báo xác thực. HTTP chỉ được khuyến nghị cho môi trường phát triển.
Triển khai các chức năng xác minh email và đặt lại mật khẩu, tích hợp giới hạn tốc độ và bảo vệ Cửa quay. Hỗ trợ tự động tạo mật khẩu ngẫu nhiên và tùy chỉnh mẫu email. Được sử dụng rộng rãi trong các tình huống như đăng ký người dùng và ràng buộc tài khoản.
🔐 Không cần xác thực
Gửi email Thư xác minh
- Tên giao diện: Gửi thư xác minh email
- Phương thức HTTP: NHẬN
- Đường dẫn:
/api/verification - Yêu cầu xác thực: Công khai (Tỷ lệ giới hạn)
- Mô tả chức năng: Gửi mã xác minh email đến địa chỉ email được chỉ định, được sử dụng cho các hoạt động liên kết hoặc xác minh email.
💡 Yêu cầu Ví dụ:
const response = await fetch(`/api/verification?email=${email}&turnstile=${turnstileToken}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();✅ Ví dụ phản hồi thành công:
{
"success": true,
"message": ""
}❗ Ví dụ về phản hồi thất bại:
{
"success": false,
"message": "Invalid parameter"
}🧾 Mô tả trường:
email(String): Địa chỉ email nhận mã xác thực; phải là định dạng email hợp lệ.turnstile(String): Token xác minh cửa quay, dùng để ngăn chặn các cuộc tấn công của bot.
Gửi thư đặt lại mật khẩu
- Tên giao diện: Gửi thư đặt lại mật khẩu
- Phương thức HTTP: NHẬN
- Đường dẫn:
/api/reset_password - Yêu cầu xác thực: Công khai (Tỷ lệ giới hạn)
- Mô tả chức năng: Gửi link đặt lại mật khẩu đến địa chỉ email đã đăng ký, dùng để người dùng lấy lại mật khẩu.
💡 Yêu cầu Ví dụ:
const response = await fetch(`/api/reset_password?email=${email}&turnstile=${turnstileToken}`, {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
});
const data = await response.json();✅ Ví dụ phản hồi thành công:
{
"success": true,
"message": ""
}❗ Ví dụ về phản hồi thất bại:
{
"success": false,
"message": "This email address is not registered"
}🧾 Mô tả trường:
email(String): Địa chỉ email yêu cầu đặt lại mật khẩu; phải là một email đã đăng ký.turnstile(String): Token xác minh cửa quay, dùng để ngăn chặn các yêu cầu độc hại.
Gửi yêu cầu đặt lại mật khẩu
- Tên giao diện: Gửi yêu cầu đặt lại mật khẩu
- Phương thức HTTP: POST
- Đường dẫn:
/api/user/reset - Yêu cầu xác thực: Công khai
- Mô tả chức năng: Hoàn tất việc đặt lại mật khẩu bằng liên kết đặt lại được cung cấp trong email. Hệ thống tạo và trả về mật khẩu mới.
💡 Yêu cầu Ví dụ:
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();✅ Ví dụ phản hồi thành công:
{
"success": true,
"message": "",
"data": "newPassword123"
}❗ Ví dụ về phản hồi thất bại:
{
"success": false,
"message": "The reset link is illegal or expired"
}🧾 Mô tả trường:
email(Chuỗi): Địa chỉ email cần đặt lại mật khẩu.token(String): Token xác minh thu được từ email reset.data(String): Mật khẩu mới được trả về khi thành công. Hệ thống tự động tạo mật khẩu ngẫu nhiên gồm 12 chữ số.