Gỡ bỏ tài khoản Simplize
API cho phép đối tác gỡ bỏ tài khoản người dùng khỏi hệ thống Simplize theo yêu cầu nghiệp vụ; hỗ trợ xử lý hàng loạt.
HTTP request
- URL:
/api/general/v1/partner/users/delete - Method:
DELETE - Content Type: None
- Response Type: application/json
Tham số header
| Header | Mô tả | Kiểu dữ liệu | Bắt buộc |
|---|---|---|---|
| X-Api-Key | Khóa duy nhất. | string | có |
Tham Số Truy Vấn (Query Parameters)
| Tên Tham Số | Kiểu Dữ Liệu | Bắt buộc | Mô Tả |
|---|---|---|---|
| recvWindow | string | không | Thời gian chấp nhận (ms), default: 5000. |
| timestamp | string | có | Unix timestamp (milliseconds). |
| signature | string | có | HMAC-SHA256 signature. |
Yêu Cầu (Request)
Request Mẫu
{
"externalUserIds": [
"USER013",
"USER012"
]
}
Chi Tiết Tham Số Request Body
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| externalUserIds | array of string | - Danh sách tài khoản cần xoá cần xoá (VD: ["USER013", "USER012"]). - Min: 1 user - Max: 100 user |
Phản Hồi (Response)
Response Mẫu
{
"status": 200,
"message": "Success",
"data": [
{
"externalUserId": "USER013",
"delete": true
},
{
"externalUserId": "USER012",
"delete": true
}
]
}
Chi Tiết Tham Số Response
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| status | number | Mã trạng thái HTTP. |
| message | string | Thông báo kết quả xử lý. |
| data | array | Danh sách kết quả gỡ bỏ theo từng tài khoản. |
Cấu trúc thuộc tính data
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| externalUserId | string | UserId của đối tác. |
| delete | boolean | - true: gỡ bỏ thành công. - false: gỡ bỏ thất bại. |