Admin
Xác minh danh tính
Các API bên dưới dùng để xác minh danh tính, khôi phục mật khẩu thông qua địa chỉ email dành riêng cho đăng nhập bằng Admin.
Xác minh tài khoản
Phương thức đăng nhập để xác minh tài khoản bằng email/username và mật khẩu thông thường.
Đăng nhập /v2/admin/auth/sign-in
| Method | Path |
|---|---|
| POST | /v2/admin/auth/sign-in |
Params:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| username | String | Yes | Username dùng để đăng nhập | username |
| password | String | Yes | Mật khẩu dùng để đăng nhập | password |
| remember-me | Boolean | No | Lưu phiên đăng nhập | true |
Nếu Tài khoản không bật xác minh 2 bước
Đăng nhập sẽ được tiến hành bình thường, trả về thông tin tài khoản và token đăng nhập.
Đăng nhập
{
"status": "success",
"message": "Đã đăng nhập thành công! Vui lòng chờ trong giây lát.",
"data": {
"type": "auth",
"token": "3|laravel_sanctum_K1iCAmxNFBouL4mCPdYV24e9YvKuc59EPBxu8qJJb94fb594",
"user": {
"id": 1,
"uuid": "0fa328d4-c6a4-4066-8daf-f9e780c984e1",
"username": "username",
"name": "User name",
"email": "email@gmail.com",
"emailVerifiedAt": "2023-09-04T09:22:10.000000Z",
"mobile": null,
"type": 0,
"level": 0,
"parentId": null,
"status": "user_active",
"createdAt": "2023-09-04T09:22:10.000000Z",
"updatedAt": "2023-09-04T09:22:10.000000Z",
"deletedAt": null,
"parsedSettings": [],
"roles": [
{
"id": 1,
"name": "Webmaster",
"custom": {
"textColor": "#DC2626",
"badge": "danger",
"icon": null,
"image": null,
"level": 0
},
"userId": null,
"createdAt": "2023-09-04 16:22:10",
"updatedAt": "2023-09-04 16:22:10",
"deletedAt": null,
"pivot": {
"userId": 1,
"roleId": 1
},
"permissions": [
]
}
],
"settings": []
},
"locale": "vi"
}
}
{
"status": "failed",
"message": "Đăng nhập sai quá nhiều lần, vui lòng thử lại sau 5 phút!",
"data": null
}
{
"status": "failed",
"message": "Đăng nhập thất bại. Vui lòng thử lại!",
"data": null
}
{
"status": "error",
"message": "Đã có lỗi xảy ra!",
"data": null
}
Nếu Tài khoản bật xác minh 2 bước
Hệ thống sẽ gửi email cùng mã xác minh về địa chỉ email của tài khoản, và trả về response bên dưới:
Xác minh 2 bước
{
"status": "success",
"message": null,
"data": {
"type": "two_fa",
"email": "email@gmail.com"
}
}
Xác minh 2 bước /v2/admin/auth/two-factor
Bước này dùng để xác minh đăng nhập đối với tài khoản có bật xác minh 2 bước (bằng email). Mã đăng nhập sẽ được gửi về email của tài khoản đó.
| Method | Path |
|---|---|
| POST | /v2/admin/auth/two-factor |
Params:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| Email string | Yes | Địa chỉ email trả về từ bước trước | email@email.com | |
| code | Number | Yes | Code được gửi về hộp mail | 12345678 |
Đăng nhập thành công
Sau khi đăng nhập thành công, json trả về sẽ giống với mục Nếu Tài khoản không bật xác minh 2 bước
Xác minh 2 bước
{
"status": "failed",
"message": "Mã xác minh hết hạn hoặc không đúng!",
"data": null
}
{
"status": "error",
"message": "Đã có lỗi xảy ra!",
"data": null
}
Quên mật khẩu
Khôi phục mật khẩu bằng địa chỉ email. Hệ thống sẽ gửi mã xác minh về địa chỉ email của tài khoản.
Gửi mã xác minh /v2/admin/auth/request-code
| Method | Path |
|---|---|
| POST | /v2/admin/auth/request-code |
Params:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| Email string | Yes | Địa chỉ email của tài khoản cần khôi phục mật khẩu | email@email.com | |
| type | String | Yes | Loại request code | reset-code |
Reset mật khẩu
{
"status": "success",
"message": null,
"data": {
"email": "email@email.com",
"step": 2,
"type": "check-code",
"password": null,
"password_confirmation": null,
"code": null,
"token": null
}
}
{
"status": "failed",
"message": "Email đã được gửi quá nhiều lần. Vui lòng thử lại sau 5 phút!",
"data": null
}
{
"status": "error",
"message": "Tài khoản không tồn tại!",
"data": null
}
{
"status": "error",
"message": "Tài khoản đã bị khóa!",
"data": null
}
{
"status": "error",
"message": "Tài khoản chưa được xác minh!",
"data": null
}
{
"status": "error",
"message": "Không thể lưu dữ liệu!",
"data": null
}
Xác minh mã xác minh /v2/admin/auth/check-code
| Method | Path |
|---|---|
| POST | /v2/admin/auth/check-code |
Params:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| String | Yes | Địa chỉ email của tài khoản cần khôi phục mật khẩu | email@email.com | |
| code | String | Yes | Mã xác minh được gửi về địa chỉ email trước đó | 12345678 |
Xác minh mã xác minh
{
"status": "success",
"message": null,
"data": {
"email": "email@email.com",
"step": 3,
"type": "check-code",
"password": null,
"password_confirmation": null,
"code": 12345678,
"token": "c6552749f0591c01fc3e20b99939d56f"
}
}
{
"status": "failed",
"message": "Mã xác minh bạn nhập không đúng!",
"data": null
}
{
"status": "failed",
"message": "Mã xác minh hết hạn hoặc không đúng!",
"data": null
}
Cập nhật mật khẩu /v2/admin/auth/set-password
| Method | Path |
|---|---|
| POST | /v2/admin/auth/set-password |
Params:
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| password | String | Yes | Mật khẩu mới | - |
| password_confirmation | String | Yes | Xác nhận mật khẩu mới | - |
| token | String | Yes | Token được trả về từ bước 2 | - |
Thiết lập mật khẩu mới
{
"status": "success",
"message": "null",
"data": {
"email": null,
"step": 4,
"type": "done",
"password": null,
"password_confirmation": null,
"code": null,
"token": null
}
}
{
"status": "failed",
"message": "Mã khôi phục không tồn tại!",
"data": null
}
{
"status": "failed",
"message": "Tài khoản không tồn tại!",
"data": null
}
{
"status": "failed",
"message": "Không thể lưu dữ liệu!",
"data": null
}