Chuyển tới nội dung chính

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

HeaderMô tảKiểu dữ liệuBắt buộc
X-Api-KeyKhóa duy nhất.string

Tham Số Truy Vấn (Query Parameters)

Tên Tham SốKiểu Dữ LiệuBắt buộcMô Tả
recvWindowstringkhôngThời gian chấp nhận (ms), default: 5000.
timestampstringUnix timestamp (milliseconds).
signaturestringHMAC-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ínhKiểu Dữ LiệuMô Tả
externalUserIdsarray 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ínhKiểu Dữ LiệuMô Tả
statusnumberMã trạng thái HTTP.
messagestringThông báo kết quả xử lý.
dataarrayDanh 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ínhKiểu Dữ LiệuMô Tả
externalUserIdstringUserId của đối tác.
deleteboolean- true: gỡ bỏ thành công.
- false: gỡ bỏ thất bại.

CREDENTIALS

* Timestamp và Signature sẽ được tự động tạo khi gọi API

RESPONSE200

{
"status": 200,
"message": "Success",
"data": [
{
"externalUserId": "USER013",
"delete": true
},
{
"externalUserId": "USER012",
"delete": true
}
]
}