ProxyLite OpenAPI

Hỗ trợ quản lý tài khoản cá nhân, tài nguyên đại lý và thanh toán nhóm thông qua tiền tố OpenAPI của trang web.

Phương thức xác thực tuân theo định nghĩa bảo mật của từng thao tác:

apiKeyAuth: Truyền Khóa API cá nhân hoặc nhóm thông qua tham số truy vấn app_key; phần phụ trợ cũng tương thích với các tham số khóa, khóa ứng dụng, openid và tham số nội dung yêu cầu POST.
BearerAuth: Ủy quyền: Bearer <JWT>, dùng cho token đăng nhập web. Đừng nghĩ Khóa API là JWT.
Khóa API nhóm được liên kết với một nhóm cố định; các giao diện hỗ trợ không gian nhóm có thể bỏ qua team_id và đầu vào rõ ràng phải nhất quán với nhóm ràng buộc Khóa.
Các giao diện chỉ hỗ trợ không gian cá nhân sẽ từ chối Khóa API của nhóm; hoạt động của nhóm vẫn tuân theo các quyền tài nguyên của thành viên nắm giữ.

Phản hồi JSON chứa mã, thông điệp, dữ liệu, request_id. code=200 có nghĩa là việc kinh doanh thành công; HTTP 200 cũng có thể mang mã lỗi kinh doanh. msg thay đổi theo ngôn ngữ yêu cầu và máy khách nên sử dụng mã để xác định kết quả. Một số giao diện xuất cũng hỗ trợ văn bản, CSV hoặc XML, hãy xem định nghĩa thao tác để biết chi tiết. Các trường số lượng, lưu lượng, ngày tháng và phân trang tuân theo Lược đồ của từng giao diện.

URL cơ sở:

https://api.proxylite.com

Xác thực

Xác thực HTTP, lược đồ: bearer

Khóa API (apiKeyAuth)
- Tên tham số: app_key, in: query. Khóa API cá nhân hoặc nhóm. Tham số truy vấn được đề xuất app_key; cũng tương thích với nội dung yêu cầu key/appkey/openid và POST. Khóa nhóm chỉ có thể truy cập các giao diện được hỗ trợ của nhóm bị ràng buộc.

Quản lý tài khoản đại lý

Danh sách tài khoản đại lý (GET /end-point/whitelist-account/list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; bỏ qua khoảng trống cá nhân hoặc truyền một chuỗi trống; Khóa nhóm có thể được bỏ qua và phải nhất quán với Khóa khi được chuyển vào

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	responseCode	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» id	integer	false	không có	Số tài khoản
»»» username	string	false	không có	Tên tài khoản đại lý
»»» password	string	false	không có	Mật khẩu tài khoản đại lý
»»» created_at	string	false	không có	Thêm thời gian
»»» remark	string	false	không có	Bình luận
»»» product_type	productTypes	false	không có	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh
»»» usage_flow	integer	false	không có	Lưu lượng đã sử dụng, đơn vị: KB
»»» limit_flow	integer	false	không có	Giới hạn lưu lượng tùy chỉnh: đơn vị GB tối đa là 102400, 0 là không giới hạn
»»» status	integer	false	không có	Trạng thái đã bật: 1 đã bật, 0 đã tắt

Giá trị liệt kê

Thuộc tính	Giá trị
product_type	9
product_type	11
product_type	14
product_type	25

Phát hiện giới hạn lưu lượng có thể được đặt trên tài khoản proxy

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» account	body	string	false	Nhập tên tài khoản khi chỉnh sửa tài khoản đại lý hiện có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
isAgent	0
isAgent	1

Nhận hạn ngạch tài khoản phụ đại lý động và số lượng đã sử dụng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/child-account

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Thêm tài khoản đại lý. (POST /end-point/whitelist-account/add)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Mật khẩu tài khoản, vui lòng điền theo định dạng tên người dùng: mật khẩu. Tài khoản và mật khẩu chỉ hỗ trợ số và chữ cái. Cấm nhập bất kỳ ký hiệu hoặc dấu cách đặc biệt nào. Dấu hai chấm ngăn cách tài khoản và mật khẩu. Tính năng bổ sung hàng loạt được hỗ trợ và các tài khoản đại lý được phân tách bằng dấu phẩy tiếng Anh (,).
» remark	body	string	false	Mô tả tài khoản đại lý
» product_type	body	productTypes	false	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh

Giá trị liệt kê

Parameter	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Xóa tài khoản proxy (POST /end-point/whitelist-account/delete)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

Xin lưu ý rằng nó không thể được khôi phục sau khi xóa và không thể truy vấn lưu lượng đã sử dụng. Sẽ có thời gian chờ khoảng 5 phút để xóa, trong thời gian đó bạn vẫn có thể bị tính phí.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Vô hiệu hóa tài khoản proxy (POST /end-point/whitelist-account/disable)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

Sẽ có thời gian chờ khoảng 5 phút để vô hiệu hóa, trong thời gian đó bạn vẫn có thể bị tính phí.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Kích hoạt tài khoản proxy (POST /end-point/whitelist-account/enable)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Đổi mật khẩu tài khoản đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-password

Xin lưu ý rằng có thời gian chờ 5 phút sau khi sửa đổi, trong thời gian đó mật khẩu cũ vẫn có thể được sử dụng bình thường.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "password": "pass"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» account	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái.
» password	body	string	true	Mật khẩu mới cho tài khoản đại lý, chỉ hỗ trợ số và chữ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Sửa đổi nhận xét tài khoản đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "remark": ""
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» account	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái.
» remark	body	string	true	Nhận xét mới cho tài khoản đại lý, trong vòng 32 ký tự tiếng Trung hoặc 64 ký tự tiếng Anh.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Sửa đổi giới hạn lưu lượng tài khoản proxy

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-limit

Xin lưu ý rằng số liệu thống kê lưu lượng truy cập có thể bị trì hoãn trong vòng 5 phút, nghĩa là lưu lượng truy cập thực tế đã sử dụng có thể vượt quá giới hạn này.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "limit": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» account	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái.
» limit	body	integer	false	Giới hạn lưu lượng, đơn vị: GB, 0 nghĩa là không có giới hạn trên

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Tạo tài khoản đại lý nhanh chóng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» product_type	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Tài khoản và mật khẩu mới sẽ được trả lại khi kinh doanh thành công.	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	none
» msg	string	false	không có	none
» request_id	string	false	không có	none
» data	any	false	không có	none

oneOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
»» anonymous	object	false	không có	none
»»» username	string	true	không có	none
»»» password	string	true	không có	none

xor

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
»» anonymous	null	false	không có	none

Sửa đổi giới hạn lưu lượng hàng ngày của tài khoản đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-daily-limit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» account	body	string	true	không có
» daily_limit	body	integer	false	Đơn vị GB

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Sửa thông tin tài khoản đại lý (POST /end-point/whitelist-account/change)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» account	body	string	true	không có
» password	body	string	false	không có
» remark	body	string	false	không có
» limit	body	integer	false	Tổng giới hạn lưu lượng tính bằng GB
» daily_limit	body	integer	false	Giới hạn lưu lượng truy cập hàng ngày tính bằng GB
» status	body	integer	false	không có
» udp	body	integer	false	không có

Giá trị liệt kê

Parameter	Value
» status	0
» status	1
» udp	0
» udp	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Làm mới bộ đệm xác thực tài khoản proxy của không gian tài nguyên hiện tại

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Hạn ngạch tài khoản đại lý cho các loại sản phẩm được chỉ định

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quota

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
product_type	query	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	none
» msg	string	false	không có	none
» request_id	string	false	không có	none
» data	object	false	không có	none
»» usage	integer	true	không có	none
»» limit	integer	true	không có	none
»» expand	integer	true	không có	none

Hạn ngạch tài khoản đại lý cho tất cả các loại sản phẩm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quotas

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	none
» msg	string	false	không có	none
» request_id	string	false	không có	none
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» product_type	integer	false	không có	none
»»» limit	integer	false	không có	none
»»» usage	integer	false	không có	none

Danh sách tài khoản đại lý (GET /end-point/proxy-account/list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-account/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; bỏ qua khoảng trống cá nhân hoặc truyền một chuỗi trống; Khóa nhóm có thể được bỏ qua và phải nhất quán với Khóa khi được chuyển vào

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	responseCode	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» id	integer	false	không có	Số tài khoản
»»» username	string	false	không có	Tên tài khoản đại lý
»»» password	string	false	không có	Mật khẩu tài khoản đại lý
»»» created_at	string	false	không có	Thêm thời gian
»»» remark	string	false	không có	Bình luận
»»» product_type	productTypes	false	không có	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh
»»» usage_flow	integer	false	không có	Lưu lượng đã sử dụng, đơn vị: KB
»»» limit_flow	integer	false	không có	Giới hạn lưu lượng tùy chỉnh: đơn vị GB tối đa là 102400, 0 là không giới hạn
»»» status	integer	false	không có	Trạng thái đã bật: 1 đã bật, 0 đã tắt

Giá trị liệt kê

Thuộc tính	Giá trị
product_type	9
product_type	11
product_type	14
product_type	25

Thêm tài khoản đại lý. (POST /end-point/proxy-account/add)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Mật khẩu tài khoản, vui lòng điền theo định dạng tên người dùng: mật khẩu. Tài khoản và mật khẩu chỉ hỗ trợ số và chữ cái. Cấm nhập bất kỳ ký hiệu hoặc dấu cách đặc biệt nào. Dấu hai chấm ngăn cách tài khoản và mật khẩu. Tính năng bổ sung hàng loạt được hỗ trợ và các tài khoản đại lý được phân tách bằng dấu phẩy tiếng Anh (,).
» remark	body	string	false	Mô tả tài khoản đại lý
» product_type	body	productTypes	false	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh

Giá trị liệt kê

Parameter	Value
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Xóa tài khoản proxy (POST /end-point/proxy-account/delete)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Kích hoạt tài khoản proxy (POST /end-point/proxy-account/enable)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Vô hiệu hóa tài khoản proxy (POST /end-point/proxy-account/disable)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/disable

Sẽ có thời gian chờ khoảng 5 phút để vô hiệu hóa, trong thời gian đó bạn vẫn có thể bị tính phí.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» accounts	body	string	true	Tài khoản đại lý, chỉ hỗ trợ số và chữ cái. Hỗ trợ thao tác hàng loạt, dấu phẩy tiếng Anh (,) phân tách tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Sửa thông tin tài khoản đại lý (POST /end-point/proxy-account/change)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

Sửa đổi mật khẩu tài khoản proxy, nhận xét, giới hạn lưu lượng, giới hạn lưu lượng hàng ngày, trạng thái bật hoặc chuyển đổi UDP.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» account	body	string	true	Tên tài khoản đại lý
» password	body	string	false	Mật khẩu mới, 6-16 chữ số hoặc chữ cái; nếu không được thông qua, nó sẽ không được sửa đổi.
» remark	body	string	false	Ghi chú mới
» limit	body	integer	false	Giới hạn lưu lượng, đơn vị GB, 0 nghĩa là không giới hạn
» daily_limit	body	integer	false	Giới hạn lưu lượng truy cập hàng ngày tính bằng GB, 0 nghĩa là không có giới hạn
» status	body	integer	false	Trạng thái đã bật
» udp	body	integer	false	Switch hỗ trợ UDP, chỉ có tác dụng với gói loại 14, 16, 21, 25

Giá trị liệt kê

Parameter	Value
» status	0
» status	1
» udp	0
» udp	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Tạo thông tin kết nối proxy

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/format

Hỗ trợ Khóa API cá nhân và nhóm. Chỉ các tài khoản đại lý có quyền truy cập vào không gian tài nguyên hiện tại mới được trả về và các loại gói 9, 11 và 12 mới được hỗ trợ. JSON/XML trả về danh sách tài khoản có cấu trúc; txt/csv trả về chuỗi kết nối được ghép ở định dạng f.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
ac	query	integer,string	true	ID tài khoản đại lý hoặc tên người dùng; tài khoản tham số tương thích
ae	query	string	false	không có
st	query	string	false	không có
ct	query	string	false	không có
lf	query	integer	false	không có
n	query	integer	false	không có
f	query	integer	false	Chỉ ảnh hưởng đến định dạng chuỗi kết nối của txt/csv
type	query	string	false	không có
lb	query	string	false	không có
ep	query	string	false	không có
team_id	query	ResourceSpaceId	false	không có

Giá trị liệt kê

Parameter	Value
f	1
f	2
f	3
f	4
f	5
type	json
type	xml
type	txt
type	csv

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}

"string"

<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	WebV1SuccessResponse

Quản lý đơn hàng

Tạo đơn hàng, yêu cầu, hủy, v.v.

danh sách đặt hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

Các đơn đặt hàng không gian nhóm cũng trả lại người tạo, cho biết thành viên đặt hàng thực tế; quản trị viên và quản trị viên cấp cao có thể xem thông tin liên hệ đầy đủ và các vai trò khác trả về thông tin liên hệ đã được giải mẫn cảm.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Đặt hàng mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
page_no	query	integer	false	không có
page_size	query	integer	false	không có
trade_no	query	string	false	số thứ tự
start_time	query	string(date-time)	false	Thời gian bắt đầu (bao gồm), chẳng hạn như 2024-01-01 00:00:00
end_time	query	string(date-time)	false	Thời gian kết thúc (không bao gồm)
status	query	integer	false	Trạng thái đơn hàng
product_type	query	integer	false	loại sản phẩm
invoice	query	integer	false	Trạng thái hóa đơn: 0 không giới hạn 1 đã lập hóa đơn -1 chưa lập hóa đơn (có thể cấp lại)
pay_fee_status	query	integer	false	Sàng lọc thanh toán dài và ngắn: 1 Thanh toán vượt mức 2 Thanh toán ngắn

Detailed descriptions

status: Trạng thái đơn hàng

Trạng thái	Mô tả
0	Đang chờ thanh toán
1	Đã trả tiền
2	Bị hủy do làm thêm giờ và không thanh toán
3	Đã hoàn tiền

product_type: loại sản phẩm

Loại sản phẩm	Mô tả
3	Nạp số dư
9	Gói lưu lượng động
11	Gói thời gian toàn cầu năng động V2
12	Gói lưu lượng IDC dài hạn
13	Gói lưu lượng IP tĩnh dân dụng
14	Gói IP tĩnh trung tâm dữ liệu
15	Gói lưu lượng ISP dài hạn
16	Gói lưu lượng tĩnh
17	Gói số lượng IP động
18	máy quét web
19	Gia hạn IP tĩnh
20	Hạn ngạch thay thế IP tĩnh
21	Gói lưu lượng tĩnh v2
24	Gói bổ sung giao thông tĩnh
25	Gói IP tĩnh dân dụng
26	Đơn đặt hàng thay thế - Một số kênh thanh toán yêu cầu người dùng điền số tiền theo cách thủ công, chẳng hạn như tiền ảo. Nếu xảy ra khoản thanh toán ngắn, bạn cần liên hệ với bộ phận dịch vụ khách hàng để thực hiện hoàn trả thông qua sản phẩm này
27	Serp
28	Video

Giá trị liệt kê

Parameter	Value
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28
invoice	-1
invoice	0
invoice	1
pay_fee_status	1
pay_fee_status	2

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	sự thành công	Inline

Lược đồ phản hồi

Tạo đơn hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

Vì có nhiều loại gói và mỗi gói có cấu hình khác nhau nên các bạn vui lòng điền thông số theo tình hình thực tế. Việc điền thông số không đúng cách có thể dẫn đến việc tạo đơn hàng không thành công.

ví dụ:

Gia hạn IP tĩnh

{
    "pid": ID gói, // lấy được từ giao diện /openapi/product
    "upids": "1,2,3,4,5,6", // Lấy trường id tương ứng từ giao diện /openapi/ip/get-static-ip
    "pm_id": 1 // Lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
  }

Mua IP tĩnh cho khu dân cư

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán, // được lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
  "khu vực_list": "JP,15,333|DE,10,444|US,5,555" // Định dạng: khu vực, số lượng, ASN|khu vực, số lượng, ASN (số ASN tùy chọn)
}

Mua IP trung tâm dữ liệu tĩnh

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán, // được lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
  "khu vực_list": "JP,15,333|DE,10,444|US,5,555" // Định dạng: khu vực, số lượng, ASN|khu vực, số lượng, ASN (số ASN tùy chọn)
}

Mua giao thông dân cư năng động

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán // Lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
}

Mua lưu lượng quay vòng tĩnh

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán // Lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
}

Mua lưu lượng truy cập không giới hạn động

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán, // được lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
  "product_sku_bandwidth_id": ID thông số băng thông,
  "product_sku_concurrency_id": ID đặc tả đồng thời
}

Nạp lại số dư

{
  "pid": ID gói, // lấy được từ giao diện /openapi/product
  "pm_id": ID phương thức thanh toán, // được lấy từ giao diện /openapi/Payment/list hoặc /openapi/Payment/groups
  "recharge_amount": số tiền nạp lại
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 0,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "use_invitation_registration_discount": true,
  "renew_duration": 0,
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» pid	body	integer	true	ID gói, từ trường id được giao diện /openapi/product trả về
» upids	body	string	false	Danh sách ID gói gia hạn (được phân tách bằng dấu phẩy), từ trường id được trả về bởi giao diện /openapi/user-product/list hoặc /openapi/ip/get-static-ip
» amount	body	number	false	Số gói mới mua
» pm_id	body	integer	true	ID phương thức thanh toán, từ trường id được trả về bởi giao diện /openapi/thanh toán/danh sách hoặc /openapi/thanh toán/nhóm
» region_list	body	string	false	Khi mua IP tĩnh, hãy chỉ định vùng + số lượng + số ASN. Định dạng là: vùng, số lượng, ASN
» coupon_sn	body	string	false	Số phiếu giảm giá
» use_invitation_registration_discount	body	boolean	false	Có nên sử dụng lời mời đăng ký giảm giá
» renew_duration	body	integer	false	Gia hạn IP tĩnh thời gian tùy chọn
» product_sku_bandwidth_id	body	integer	false	Gói 11: ID gói băng thông
» product_sku_concurrency_id	body	integer	false	Gói 11: ID gói đồng thời
» product_sku_duration_id	body	integer	false	Loại gói=11Bắt buộc: ID thông số thời lượng
» etd	body	integer	false	Bội số thời lượng, lấy từ gói gia hạn_of_time_days, 2 thể hiện số ngày × 2, giá sẽ tăng
» recharge_amount	body	integer	false	Gói 3: Số tiền nạp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Đã tạo thành công	Inline

Lược đồ phản hồi

Hủy đơn hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» trade_no	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Chi tiết đặt hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
trade_no	query	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Chi tiết đặt hàng V2

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info-v2

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
order_id	query	string	true	ID đơn hàng được mã hóa phía khách hàng

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi đơn hàng đã được thanh toán hoặc bị hủy, dữ liệu đơn hàng có thể được mang theo mã lỗi kinh doanh	Inline

Lược đồ phản hồi

Cấp lại hóa đơn cho đơn hàng cũ

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» trade_no_list	body	[string]	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Kiểm tra trước đơn hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

Được gọi trước khi tạo đơn hàng, nó được sử dụng để xem trước giá cả, chiết khấu, chi tiết gia hạn IP, v.v. Đơn hàng sẽ không thực sự được tạo. Các tham số hoàn toàn giống với /openapi/order/create.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» pid	body	integer	true	Mã gói
» upids	body	string	false	Gia hạn IP: danh sách ID gói người dùng, phân tách bằng dấu phẩy
» amount	body	integer	false	Số lượng mua
» pm_id	body	integer	true	Mã phương thức thanh toán
» region_list	body	string	false	Vùng mua IP tĩnh + số lượng, định dạng: ID vùng, số lượng
» coupon_sn	body	string	false	Số phiếu giảm giá
» renew_duration	body	string	false	Thời gian gia hạn IP: 1 tháng=1 tháng, 2 tháng=2 tháng, em=cuối tháng tiếp theo
» product_sku_bandwidth_id	body	integer	false	Loại gói=11Bắt buộc: ID thông số băng thông
» product_sku_concurrency_id	body	integer	false	Loại gói=11Bắt buộc: ID thông số đồng thời
» product_sku_duration_id	body	integer	false	Loại gói=11Bắt buộc: ID thông số thời lượng
» etd	body	integer	false	Bội số thời lượng, thu được từ gói gia hạn_of_time_days
» recharge_amount	body	number	false	Loại gói=3Bắt buộc: số tiền nạp lại

Giá trị liệt kê

Parameter	Value
» renew_duration	1m
» renew_duration	2m
» renew_duration	em

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Chuyến bay trước thành công	Inline

Lược đồ phản hồi

Quản lý khóa API

Quản lý khóa API cho không gian tài nguyên cá nhân và nhóm

Danh sách khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/api-keys

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
page	query	integer	false	không có
pageSize	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	none
» msg	string	true	không có	none
» request_id	string	true	không có	none
» data	object	true	không có	none
»» list	[UserApiKeyMetadata]	true	không có	none
»»» id	integer	true	không có	API Key ID
»»» api_key	string	true	không có	Phản hồi tạo là Khóa hoàn chỉnh; danh sách nhóm là giá trị bị che
»»» team_user_id	integer	true	không có	Khóa nhóm thực sự chứa ID thành viên và khóa cá nhân là 0
»»» remark	string	true	không có	Bình luận
»»» status	integer	true	không có	0=vô hiệu hóa, 1=kích hoạt
»»» created_at	string	true	không có	thời gian sáng tạo
»»» updated_at	string,null	false	không có	Thời gian cập nhật
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» pageSize	integer	true	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1

Tạo khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» remark	body	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Trả lại API Key đầy đủ khi kinh doanh thành công, chỉ lần này thôi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1

Kích hoạt khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	API Key ID

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Vô hiệu hóa khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	API Key ID

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Xóa khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	API Key ID

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Sửa đổi nhận xét về Khóa API

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	không có
» remark	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Hóa đơn gia hạn hàng tháng

Thanh toán theo thời gian thực, kiểm tra trước, đặt hàng và lịch sử gia hạn tổng hợp hàng tháng

Hóa đơn gia hạn tóm tắt hàng tháng hiện tại

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
type	current
type	next

Kiểm tra đơn đặt hàng gia hạn tóm tắt hàng tháng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	MonthlyRenewalRequest	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
type	current
type	next

Tạo lệnh gia hạn tóm tắt hàng tháng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	MonthlyRenewalRequest	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Bản tóm tắt hàng tháng về hóa đơn lịch sử gia hạn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill/history

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
trade_no	query	string	false	không có
start_date	query	string(date)	false	không có
end_date	query	string(date)	false	không có
page	query	integer	false	không có
size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Quản lý hóa đơn

Tiêu đề hóa đơn, ứng dụng lập hóa đơn và các đơn đặt hàng có thể xuất hóa đơn

Chi tiết tiêu đề hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/info

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
invoice_code	query	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Tạo hoặc sửa đổi tiêu đề hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	any	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công, dữ liệu rỗng	Inline

Lược đồ phản hồi

Danh sách tiêu đề hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Xóa tiêu đề hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invoice_code	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công, dữ liệu rỗng	Inline

Lược đồ phản hồi

Danh sách ghi hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/record-list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
status	query	integer	false	không có

Giá trị liệt kê

Parameter	Value
status	0
status	1
status	2
status	3
status	4

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

Gửi đơn xin thanh toán

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invoice_code	body	string	true	không có
» order_ids	body	[integer]	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Hủy ứng dụng thanh toán

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invoice_id	body	integer	true	không có
» reason	body	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công, dữ liệu rỗng	Inline

Lược đồ phản hồi

Thống kê số lượng hóa đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/statistics

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Danh sách các đơn hàng có thể được lập hoá đơn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/invoiceable-orders

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Quản lý đội

Tạo nhóm, truy vấn, đổi tên và giải tán

Tạo một đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/create

Body parameter

{
  "name": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» name	body	string	true	Tên đội

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Danh sách các đội mà người dùng hiện tại có thể truy cập

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Chi tiết đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/detail

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Sửa đổi tên đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» name	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Giải tán đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/dissolve

Chỉ quản trị viên cấp cao của nhóm mới có thể gọi điều này. Tên trong yêu cầu phải khớp chính xác với tên hiện tại của đội. Giao diện này thực thi xác minh hai bước của các hoạt động: code=348 được trả về khi không ở trạng thái tin cậy 15 phút, Người gọi phải lấy mã xác minh theo các phương thức có sẵn trong dữ liệu phản hồi, sau đó thử lại với verify_type và verify_code. Có thể gọi đi gọi lại nhiều lần để tiếp tục quá trình giải thể còn dang dở.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» name	body	string	true	Xác nhận tên đội, phải giống hệt với tên hiện tại của đội
» verify_type	body	string	false	Phương pháp xác minh thứ cấp; gửi cùng với verify_code khi cần xác minh
» verify_code	body	string	false	Mã xác minh hai bước; không bắt buộc khi ở trạng thái tin cậy 15 phút

Giá trị liệt kê

Parameter	Value
» verify_type	phone
» verify_type	email
» verify_type	wechat
» verify_type	totp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

Truy vấn trạng thái giải tán nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/dissolve-status

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

thành viên trong nhóm

Danh sách thành viên nhóm, điều chỉnh vai trò, xóa và thoát

Danh sách thành viên nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/members

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Danh sách thống nhất các thành viên trong nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/people

Các thành viên hợp lệ được trả về; quản trị viên cấp cao và quản trị viên cũng nhìn thấy lời mời đang chờ xử lý. Các trạng thái lời mời khác chỉ còn trong danh sách lịch sử lời mời.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

Điều chỉnh vai trò thành viên

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» team_member_id	body	integer	true	không có
» role	body	integer	true	không có

Giá trị liệt kê

Parameter	Value
» role	2
» role	3

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Xóa thành viên nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» team_member_id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi việc kinh doanh thành công data.status=3	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Rời khỏi đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi việc kinh doanh thành công, data.status=2	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Lời mời của đội

Tạo, truy vấn và xử lý lời mời thành viên nhóm

Tạo lời mời nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/create

Tạo lời mời theo người dùng đã đăng ký, email hoặc số điện thoại di động. Khi email hoặc số điện thoại di động khớp với người dùng trên trang web này, phản hồi sẽ được chuẩn hóa thành lời mời_type=1. Giao diện người dùng có thể gửi mẫu đường dẫn tương đối của URL lời mời của trang web này và máy chủ chỉ thay thế trong đó bằng mã thông báo lời mời một lần. Sau khi mục tiêu chưa đăng ký đăng ký bằng số điện thoại di động được mời hoặc hoàn tất xác minh bằng email được mời, máy chủ sẽ liên kết lời mời vẫn hợp lệ với người dùng mới, xoay mã thông báo và chỉ gửi lại tin nhắn trong trang web chưa đọc; mã thông báo cũ trong email hoặc tin nhắn văn bản ban đầu sẽ không còn hợp lệ. Nếu lời mời qua email chưa được tự động ràng buộc, tài khoản hiện tại đã đăng ký bằng địa chỉ email được mời có thể được chấp nhận trực tiếp mà không cần đợi email_verify.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invite_type	body	integer	true	1=Người dùng đã đăng ký, 2=Email, 3=Số điện thoại di động
» role	body	integer	true	2=quản trị viên, 3=thành viên bình thường
» user_id	body	integer	false	Bắt buộc khi mời_type=1
» email	body	string(email)	false	Bắt buộc khi mời_type=2
» country_code	body	integer	false	Bắt buộc khi mời_type=3
» phone	body	string	false	Bắt buộc khi mời_type=3
» invitation_url_template	body	string	false	Mẫu đường dẫn tương đối được xác định bởi giao diện người dùng của trang web này; phải bắt đầu bằng một /, không được chứa tên miền hoặc dòng mới, đồng thời phải và chỉ có thể chứa một phần giữ chỗ
» anonymous	body	object	false	không có
»» invite_type	body	any	false	không có
» anonymous	body	object	false	không có
»» invite_type	body	any	false	không có
» anonymous	body	object	false	không có
»» invite_type	body	any	false	không có

Giá trị liệt kê

Parameter	Value
» invite_type	1
» invite_type	2
» invite_type	3
» role	2
» role	3

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi, 200 nghĩa là kinh doanh thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

Danh sách mời đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/invitations

Chỉ có quản trị viên cấp cao hoặc quản trị viên nhóm mới có thể truy cập được; những lời mời đang chờ xử lý đã hết hạn sẽ được cập nhật thành đã hết hạn trước khi quay lại.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	Danh tính công khai của nhóm
page	query	integer	false	Số trang, bắt đầu từ 1
page_size	query	integer	false	Số lượng mỗi trang

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Xem trước lời mời của nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /end-point/team/invitations/preview

Xem trước lời mời ẩn danh bằng cách sử dụng lời mời_token một lần; không có ID số lời mời nào được sử dụng trong liên kết.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
invitation_token	query	string	true	Mã thông báo một lần bằng văn bản gốc không trống được mang theo liên kết lời mời

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Gửi lại thông báo mời nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/resend

Tái đầu tư vào kênh gửi ban đầu; người dùng đã đăng ký cũng gửi tin nhắn trang web. Việc gửi lại mã thông báo sẽ luân chuyển mã thông báo và tất cả các liên kết mời trước đó sẽ không hợp lệ ngay lập tức.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invitation_id	body	integer	true	ID lời mời

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

Chấp nhận lời mời của đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/accept

Người dùng hiện đã đăng nhập sử dụng lời mời_token một lần để chấp nhận lời mời, lời mời này phải phù hợp với mục tiêu lời mời và thuộc về trang web chứa lời mời; không cần phải vượt qua team_id.

Body parameter

{
  "invitation_token": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» invitation_token	body	string	true	Xóa văn bản mã thông báo lời mời một lần

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu là đối tượng thành viên	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

Từ chối lời mời tham gia nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/reject

Người dùng hiện đã đăng nhập sử dụng lời mời_token một lần để từ chối lời mời phù hợp với người dùng; không cần phải vượt qua team_id.

Body parameter

{
  "invitation_token": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» invitation_token	body	string	true	Xóa văn bản mã thông báo lời mời một lần

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi việc kinh doanh thành công, data.status=2	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Hủy lời mời tham gia nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/cancel

Để hủy lời mời đang chờ xử lý trong một nhóm được chỉ định, người điều hành phải có quyền mời nhân vật mục tiêu.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» invitation_id	body	integer	true	ID lời mời

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi việc kinh doanh thành công data.status=3	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

Tài sản của nhóm

Truy vấn tài sản nhóm và chuyển không gian cá nhân/nhóm

Thông tin gói đội

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/product-info

Trả về bản tóm tắt gói của không gian tài nguyên nhóm đã chỉ định. Các trường nhất quán với các trường gói của /web_v1/user/info. Không trả về hồ sơ, số dư hoặc ID nhóm nội bộ của quản trị viên cấp cao. Vui lòng sử dụng /web_v1/credit/info để biết chi tiết về gói tín dụng.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Danh sách tài sản nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Tài sản cá nhân có thể được chỉ định cho nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets/personal-candidates

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Chuyển tài sản cá nhân cho nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Tài sản của nhóm được chuyển trở lại cho cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Quản lý điểm

Thông tin gói điểm, bổ sung tự động, hồ sơ và thống kê tiêu thụ

Nhận thông tin gói điểm (GET /web_v1/credit/info)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

Truy vấn bản tóm tắt gói điểm của không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền USE_ASSETS; giao diện này hỗ trợ trạng thái đăng nhập, Khóa API cá nhân và Khóa API nhóm cùng một lúc.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bị bỏ qua hoặc một chuỗi trống được chuyển qua; Khóa API của nhóm có thể được bỏ qua và phải nhất quán với Khóa khi được chuyển vào

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu là mức điểm, tổng số tiền, số tiền còn lại, thời gian đặt lại và trạng thái bổ sung tự động.	Inline

Lược đồ phản hồi

Thiết lập số dư để tự động bổ sung điểm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

Đặt công tắc bổ sung tự động của không gian tài nguyên hiện tại ở trạng thái đăng nhập. Không gian nhóm yêu cầu quyền USE_OWNER_PAYMENT_CAPABILITIES, hiện tại chỉ quản trị viên cấp cao của nhóm mới có thể hoạt động; không gian nhóm được đóng theo mặc định.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» status	body	integer	true	0=tắt, 1=bật

Giá trị liệt kê

Parameter	Value
» status	0
» status	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, data.status là trạng thái chuyển đổi được cập nhật.	Inline

Lược đồ phản hồi

Nhận hồ sơ tiêu thụ điểm (GET /web_v1/credit/consumption-logs)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

Truy vấn bản ghi tiêu thụ điểm của không gian tài nguyên hiện tại ở trạng thái đăng nhập hoặc trang Khóa API. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, được diễn giải theo múi giờ của trang web
end_date	query	string(date)	false	Ngày kết thúc, được diễn giải theo múi giờ của trang web
consumption_type	query	string	false	Loại tiêu thụ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu bao gồm danh sách, trang, page_size, Total_count và Total_page	Inline

Lược đồ phản hồi

Nhận bản ghi thiết lập lại điểm (GET /web_v1/credit/reset-logs)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

Truy vấn bản ghi đặt lại điểm của không gian tài nguyên hiện tại ở trạng thái đăng nhập hoặc trang Khóa API. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa các bản ghi đặt lại điểm và thông tin phân trang.	Inline

Lược đồ phản hồi

Nhận thống kê điểm (GET /web_v1/credit/stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

Đăng nhập hoặc Khóa API để truy vấn số liệu thống kê điểm được tổng hợp theo loại mức tiêu thụ của không gian tài nguyên hiện tại. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, được diễn giải theo múi giờ của trang web
end_date	query	string(date)	false	Ngày kết thúc, được diễn giải theo múi giờ của trang web

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu chứa by_type và tổng	Inline

Lược đồ phản hồi

Nhận thống kê điểm hàng ngày (GET /web_v1/credit/daily-stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

Đăng nhập hoặc Khóa API để truy vấn mức tiêu thụ điểm hàng ngày của không gian tài nguyên hiện tại, mặc định là 7 ngày qua. Các thành viên bình thường của nhóm chỉ trả lại mức tiêu thụ thực tế của họ; quản trị viên, quản trị viên cấp cao và thành viên tài chính có quyền VIEW_BILLING trả lại toàn bộ dữ liệu của nhóm. Nhật ký nhóm của các thành viên tiêu dùng không được ghi lại chỉ hiển thị ở chế độ xem đầy đủ. Truy vấn khóa API có thể chứa tối đa 31 ngày tự nhiên (đã bao gồm) và ngày bắt đầu không được muộn hơn ngày kết thúc.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, mặc định 6 ngày trước
end_date	query	string(date)	false	Ngày kết thúc, mặc định là hôm nay
consumption_type	query	string	false	Các loại tiêu thụ tùy chọn
fill_gaps	query	integer	false	Có nên điền ngày còn thiếu hay không

Giá trị liệt kê

Parameter	Value
fill_gaps	0
fill_gaps	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa số liệu thống kê hàng ngày và tóm tắt	Inline

Lược đồ phản hồi

Nhận thống kê điểm hàng giờ (GET /web_v1/credit/hourly-stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

Đăng nhập hoặc Khóa API để truy vấn mức tiêu thụ điểm hàng giờ của không gian tài nguyên hiện tại, mặc định là 7 ngày qua. Không gian nhóm yêu cầu quyền VIEW_BILLING. Truy vấn khóa API có thể chứa tối đa 31 ngày tự nhiên (đã bao gồm) và ngày bắt đầu không được muộn hơn ngày kết thúc.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, mặc định 6 ngày trước
end_date	query	string(date)	false	Ngày kết thúc, mặc định là hôm nay
consumption_type	query	string	false	Các loại tiêu thụ tùy chọn
fill_gaps	query	integer	false	Có điền số giờ còn thiếu hay không

Giá trị liệt kê

Parameter	Value
fill_gaps	0
fill_gaps	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu sẽ chứa số liệu thống kê theo giờ và tóm tắt	Inline

Lược đồ phản hồi

Nhận thông tin gói điểm (GET /end-point/credit/info)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/info

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bị bỏ qua hoặc một chuỗi trống được chuyển qua; Khóa API của nhóm có thể được bỏ qua và phải nhất quán với Khóa khi được chuyển vào

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu là mức điểm, tổng số tiền, số tiền còn lại, thời gian đặt lại và trạng thái bổ sung tự động.	Inline

Lược đồ phản hồi

Nhận hồ sơ tiêu thụ điểm (GET /end-point/credit/consumption-logs)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/consumption-logs

Truy vấn bản ghi tiêu thụ điểm của không gian tài nguyên hiện tại ở trạng thái đăng nhập hoặc trang Khóa API. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, được diễn giải theo múi giờ của trang web
end_date	query	string(date)	false	Ngày kết thúc, được diễn giải theo múi giờ của trang web
consumption_type	query	string	false	Loại tiêu thụ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu bao gồm danh sách, trang, page_size, Total_count và Total_page	Inline

Lược đồ phản hồi

Nhận bản ghi thiết lập lại điểm (GET /end-point/credit/reset-logs)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/reset-logs

Truy vấn bản ghi đặt lại điểm của không gian tài nguyên hiện tại ở trạng thái đăng nhập hoặc trang Khóa API. Không gian nhóm yêu cầu quyền VIEW_BILLING.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa các bản ghi đặt lại điểm và thông tin phân trang.	Inline

Lược đồ phản hồi

Nhận thống kê điểm (GET /end-point/credit/stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/stats

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, được diễn giải theo múi giờ của trang web
end_date	query	string(date)	false	Ngày kết thúc, được diễn giải theo múi giờ của trang web

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu chứa by_type và tổng	Inline

Lược đồ phản hồi

Nhận thống kê điểm hàng ngày (GET /end-point/credit/daily-stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/daily-stats

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, mặc định 6 ngày trước
end_date	query	string(date)	false	Ngày kết thúc, mặc định là hôm nay
consumption_type	query	string	false	Các loại tiêu thụ tùy chọn
fill_gaps	query	integer	false	Có nên điền ngày còn thiếu hay không

Giá trị liệt kê

Parameter	Value
fill_gaps	0
fill_gaps	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa số liệu thống kê hàng ngày và tóm tắt	Inline

Lược đồ phản hồi

Nhận thống kê điểm hàng giờ (GET /end-point/credit/hourly-stats)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/hourly-stats

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Ngày bắt đầu, mặc định 6 ngày trước
end_date	query	string(date)	false	Ngày kết thúc, mặc định là hôm nay
consumption_type	query	string	false	Các loại tiêu thụ tùy chọn
fill_gaps	query	integer	false	Có điền số giờ còn thiếu hay không

Giá trị liệt kê

Parameter	Value
fill_gaps	0
fill_gaps	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu sẽ chứa số liệu thống kê theo giờ và tóm tắt	Inline

Lược đồ phản hồi

Xcrawl Activity Log

Bản ghi nhiệm vụ đơn lẻ và hàng loạt của Xcrawl, truy vấn chi tiết và tóm tắt

Nhận danh sách các tác vụ Xcrawl gần đây

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

Đăng nhập để truy vấn danh sách nhiệm vụ đơn lẻ và tóm tắt không gian tài nguyên hiện tại. Không gian nhóm yêu cầu USE_ASSETS; các thành viên thông thường chỉ có thể xem các nhiệm vụ được tạo bởi thông tin xác thực của chính họ, còn quản trị viên và quản trị viên cấp cao có thể xem các nhiệm vụ của toàn bộ nhóm.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có
endpoint	query	string	false	loại điểm cuối
status	query	string	false	không có
start_time	query	string	false	Giờ múi giờ của người dùng, định dạng Y-m-d H:i:s
end_time	query	string	false	Múi giờ của người dùng, bao gồm cả ranh giới cuối
url	query	string	false	URL mục tiêu hoặc ID trình thu thập dữ liệu
job_id	query	string	false	Tiền tố ID nhiệm vụ

Giá trị liệt kê

Parameter	Value
status	pending
status	crawling
status	completed
status	failed

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa danh sách phân trang và siêu dữ liệu	Inline

Lược đồ phản hồi

Nhận kết quả thu thập thông tin Xcrawl

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

Ở trạng thái đăng nhập, truy vấn Kết quả thu thập thông tin của tác vụ được chỉ định trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu USE_ASSETS và xác minh quyền sở hữu nhiệm vụ dựa trên phạm vi thông tin xác thực hiển thị của thành viên.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
job_id	query	string	true	ID nhiệm vụ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, dữ liệu chứa job_id và crawl_result	Inline

Lược đồ phản hồi

Nhận chi tiết và nhật ký nhiệm vụ Xcrawl

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

Ở trạng thái đăng nhập, hãy truy vấn không gian tài nguyên hiện tại để chỉ định một tác vụ và chi tiết kết quả của nó. Không gian nhóm yêu cầu USE_ASSETS và xác minh quyền sở hữu nhiệm vụ dựa trên phạm vi thông tin xác thực hiển thị của thành viên.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
job_id	query	string	true	ID nhiệm vụ
page	query	integer	false	số trang của kết quả phụ thu thập dữ liệu/dữ liệu
page_size	query	integer	false	số lượng thu thập dữ liệu/dữ liệu của các trang kết quả phụ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa công việc và thông tin chi tiết được thay đổi theo điểm cuối.	Inline

Lược đồ phản hồi

Nhận số liệu thống kê tổng hợp URL dữ liệu

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

Tác vụ quét dữ liệu tổng hợp không gian tài nguyên hiện tại ở trạng thái đăng nhập. Không gian nhóm yêu cầu USE_ASSETS và kết quả tuân theo phạm vi thông tin xác thực hiển thị của thành viên.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
limit	query	integer	false	Trả lại số lượng; 0 trả về một danh sách trống

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi kinh doanh thành công, data.list là kết quả tổng hợp của Scraper.	Inline

Lược đồ phản hồi

Nhận danh sách các tác vụ thu thập thông tin hàng loạt gần đây

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

Đăng nhập để truy vấn danh sách nhiệm vụ hàng loạt và tóm tắt không gian tài nguyên hiện tại. Không gian nhóm yêu cầu USE_ASSETS; các thành viên thông thường chỉ có thể xem các nhiệm vụ được tạo bởi thông tin xác thực của chính họ, còn quản trị viên và quản trị viên cấp cao có thể xem các nhiệm vụ của toàn bộ nhóm.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có
endpoint	query	string	false	Loại điểm cuối, thường là batch_scrape
status	query	string	false	không có
start_time	query	string	false	Giờ múi giờ của người dùng, định dạng Y-m-d H:i:s
end_time	query	string	false	Múi giờ của người dùng, bao gồm cả ranh giới cuối
batch_id	query	string	false	Tiền tố ID nhiệm vụ hàng loạt

Giá trị liệt kê

Parameter	Value
status	pending
status	crawling
status	completed
status	failed

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa danh sách phân trang và siêu dữ liệu	Inline

Lược đồ phản hồi

Nhận chi tiết và nhật ký nhiệm vụ thu thập thông tin hàng loạt

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

Ở trạng thái đăng nhập, truy vấn các tác vụ hàng loạt được chỉ định và kết quả mục con của chúng trong không gian tài nguyên hiện tại. Không gian nhóm yêu cầu USE_ASSETS và xác minh quyền sở hữu nhiệm vụ dựa trên phạm vi thông tin xác thực hiển thị của thành viên.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
batch_id	query	string	true	ID nhiệm vụ hàng loạt
page	query	integer	false	Số trang tiểu mục
page_size	query	integer	false	Số lượng trang phụ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; khi doanh nghiệp thành công, dữ liệu chứa chi tiết công việc và nhiệm vụ hàng loạt	Inline

Lược đồ phản hồi

Quản lý tài khoản

Nhận tổng quan về tài khoản cá nhân của bạn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/account/profile

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Kiểm tra sao kê số dư cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/wallet/change-list

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
re_type	query	integer	false	không có
transaction_type	query	integer	false	không có
balance_type	query	integer	false	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Giá trị liệt kê

Parameter	Value
re_type	0
re_type	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Xuất nhật ký

Tạo tác vụ xuất nhật ký đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/create

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ. Thời gian bắt đầu phải sớm hơn thời gian kết thúc và khoảng thời gian không quá 31 ngày; cùng một người dùng chỉ được phép một tác vụ xuất đang chờ hoặc xử lý và giới hạn trên của nhật ký là 5 triệu.

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» start_time	body	integer	true	Bắt đầu dấu thời gian Unix, giây
» end_time	body	integer	true	kết thúc dấu thời gian Unix, giây
» type	body	string	false	không có

Giá trị liệt kê

Parameter	Value
» type	dynamic
» type	host_pool

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Chi tiết nhiệm vụ xuất nhật ký truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/detail

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
task_id	query	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

Danh sách tác vụ xuất nhật ký truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/list

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
page	query	integer	false	không có
size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

Hủy tác vụ xuất nhật ký chưa được thực hiện

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/cancel

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ. Chỉ các tác vụ ở trạng thái chờ trong hàng đợi mới có thể bị hủy và các tác vụ đã được thực thi thì không thể bị hủy.

Body parameter

{
  "task_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» task_id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Phiếu giảm giá

Truy vấn danh sách phiếu giảm giá cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/list

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» status	body	integer	false	không có
» page	body	integer	false	không có
» size	body	integer	false	không có

Giá trị liệt kê

Parameter	Value
» status	0
» status	1
» status	2

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Kiểm tra chi tiết phiếu giảm giá cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/info

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Quản lý thông báo

Kiểm tra thông báo trang web

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/list

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
page	query	integer	false	không có
size	query	integer	false	không có
read	query	integer	false	không có
type	query	integer	false	không có

Giá trị liệt kê

Parameter	Value
read	0
read	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
read_status	0
read_status	1

Kiểm tra chi tiết thông báo trang web

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/detail

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
id	query	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
read_status	0
read_status	1

Đánh dấu thông báo trang web là đã đọc

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/read

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Đánh dấu thông báo trang web là đã đọc theo đợt

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/batch-read

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "ids": [
    1
  ]
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» ids	body	[integer]	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Cấu hình kênh thông báo truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notify

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Email thông báo truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/list

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Kịch bản thông báo truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/scenes

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Kịch bản đăng ký email truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/email-scenes

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
id	query	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Cấu hình đại lý

Truy vấn bộ đệm của tác nhân cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-cache/status

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1

Đặt công tắc bộ nhớ đệm proxy cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-cache/change

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "status": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» status	body	integer	true	không có

Giá trị liệt kê

Parameter	Value
» status	0
» status	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Truy vấn chuyển đổi UDP đại lý cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-proxy-config/udp

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
enabled	0
enabled	1

Đặt chuyển đổi UDP đại lý cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-proxy-config/udp

Chỉ hỗ trợ trạng thái đăng nhập của không gian cá nhân hoặc Khóa API cá nhân; Khóa API nhóm không được hỗ trợ.

Body parameter

{
  "udp": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» udp	body	integer	true	không có

Giá trị liệt kê

Parameter	Value
» udp	0
» udp	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng kiểm tra mã doanh nghiệp, 200 nghĩa là thành công.	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
enabled	0
enabled	1

Ví nhóm

Ví nhóm truy vấn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/detail

Yêu cầu quyền VIEW_BILLING. Ví của nhóm độc lập với quản trị viên cấp cao và số dư cá nhân của thành viên.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Kiểm tra luồng ví của nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/records

Yêu cầu quyền VIEW_BILLING. Số tiền doanh thu luôn là số dương và việc tăng hoặc giảm số tiền được biểu thị bằng trường hướng.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	TeamPublicId	true	không có
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

Chuyển số dư cá nhân sang ví nhóm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-in

Chỉ quản trị viên cấp cao của nhóm mới có quyền TRANSFER_BALANCE. Ví của nhóm được thêm vào sau khi trừ đi số dư nạp tiền cá nhân; số tiền đã chuyển không được bao gồm trong Total_recharge_fee và không hỗ trợ chuyển về số dư cá nhân.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» amount	body	number(double)	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Chuyển số dư của đội trở lại tài khoản cá nhân

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-out

Nó chỉ có thể được gọi khi quản trị viên cấp cao đăng nhập. Các khoản khấu trừ nguyên tử từ ví của nhóm và tăng số dư nạp lại cá nhân của họ; không thay đổi số tiền nạp tích lũy của tập thể, cá nhân. Đội đã giải tán có thể lấy lại số dư nhưng không thể gọi đội đã giải tán.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	TeamPublicId	true	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» amount	body	number(double)	true	Không được vượt quá số dư hiện có của đội

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	HTTP thành công; vui lòng tiếp tục đánh giá mã nội dung phản hồi	Inline

Lược đồ phản hồi

Khai thác IP

Trích xuất IP (GET /end-point/ip/get-ip)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-ip

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Khóa nhóm có thể được bỏ qua; khi được chuyển vào, nó phải phù hợp với đội mà Chìa khóa được ràng buộc.
app_key	query	string(password)	true	phím truy cập
cc	query	string	false	Quốc gia hoặc khu vực
state	query	string	false	tỉnh hoặc tiểu bang
city	query	string	false	thành phố
format	query	string	false	Nhận định dạng
lb	query	string	false	Dấu phân cách, chỉ hợp lệ ở định dạng văn bản
num	query	number	false	Trích xuất số lượng
life	query	number	false	Thời gian giữ - phút
ep	query	string	false	mạng proxy

Giá trị liệt kê

Parameter	Value
ep	us
ep	hk
ep	de

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[any]	false	không có	none

Danh sách thành phố (GET /end-point/ip/dynamic-area-city-list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-area-city-list

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	danh sách
»»» name_zh_cn	string	false	không có	Tên quốc gia hoặc khu vực
»»» name_en	string	false	không có	Tên quốc gia hoặc khu vực
»»» continent_code	string	false	không có	mã lục địa
»»» country_code	string	false	không có	Mã quốc gia hoặc vùng
»»» items	[any]	false	không có	tỉnh hoặc tiểu bang
»»»» city	string	false	không có	tên thành phố
»»»» state	string	false	không có	Mã tên tỉnh hoặc tiểu bang
»»»» continent_code	string	false	không có	mã lục địa
»»»» country_code	string	false	không có	Mã quốc gia hoặc vùng

Thống kê số lượng khai thác IP theo ngày

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-extract-ip/days

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_date	query	string(date)	false	Mặc định 6 ngày trước
end_date	query	string(date)	false	Mặc định hôm nay
product_type	query	integer	false	không có

Giá trị liệt kê

Parameter	Value
product_type	9
product_type	17
product_type	22

Ví dụ phản hồi

Phản hồi 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	none
» msg	string	false	không có	none
» request_id	string	false	không có	none
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» count	integer	true	không có	none
»»» date	string(date)	true	không có	none

Trích xuất IP (GET /end-point/ip/v3)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Khóa nhóm có thể được bỏ qua; khi được chuyển vào, nó phải phù hợp với đội mà Chìa khóa được ràng buộc.
app_key	query	string(password)	true	phím truy cập
cc	query	string	false	Quốc gia hoặc khu vực
state	query	string	false	tỉnh hoặc tiểu bang
city	query	string	false	thành phố
format	query	string	false	Nhận định dạng
lb	query	string	false	Dấu phân cách, chỉ hợp lệ ở định dạng văn bản
num	query	number	false	Trích xuất số lượng
life	query	number	false	Thời gian giữ - phút
ep	query	string	false	mạng proxy

Giá trị liệt kê

Parameter	Value
ep	us
ep	hk
ep	de

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[any]	false	không có	none

Danh sách thành phố khu vực năng động V4

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

Lấy danh sách thành phố theo tên người dùng, yêu cầu xác thực đăng nhập và tài khoản phải thuộc về người dùng hiện tại

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
username	query	string	true	Tên người dùng tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» cache	boolean	false	không có	Cho dù nó đến từ bộ nhớ đệm
»» list	[object]	false	không có	none
»»» City	string	false	không có	thành phố
»»» Area	string	false	không có	khu vực
»»» State	string	false	không có	Tiểu bang/Tỉnh

Danh sách tỉnh/bang khu vực động V4

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

Nhận danh sách tiểu bang/tỉnh theo tên người dùng, yêu cầu xác thực đăng nhập và tài khoản phải thuộc về người dùng hiện tại

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
username	query	string	true	Tên người dùng tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» cache	boolean	false	không có	Cho dù nó đến từ bộ nhớ đệm
»» list	[object]	false	không có	none
»»» City	string	false	không có	thành phố
»»» Area	string	false	không có	khu vực
»»» State	string	false	không có	Tiểu bang/Tỉnh

Danh sách hợp nhất thành phố/tỉnh khu vực năng động V4

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

Nhận danh sách hợp nhất các tiểu bang/tỉnh và thành phố theo tên người dùng, được nhóm theo khu vực. Cần phải xác thực đăng nhập và tài khoản phải thuộc về người dùng hiện tại

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
username	query	string	true	Tên người dùng tài khoản đại lý

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» cache	boolean	false	không có	Cho dù nó đến từ bộ nhớ đệm
»» list	[object]	false	không có	Danh sách khu vực
»»» Area	string	false	không có	mã vùng
»»» states	[object]	false	không có	Danh sách Tiểu bang/Tỉnh
»»»» State	string	false	không có	Tên tiểu bang/tỉnh
»»»» cities	[string]	false	không có	Danh sách thành phố

Danh sách thành phố (GET /end-point/ip/dynamic-citys)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	danh sách
»»» name_zh_cn	string	false	không có	Tên quốc gia hoặc khu vực
»»» name_en	string	false	không có	Tên quốc gia hoặc khu vực
»»» continent_code	string	false	không có	mã lục địa
»»» country_code	string	false	không có	Mã quốc gia hoặc vùng
»»» items	[any]	false	không có	tỉnh hoặc tiểu bang
»»»» city	string	false	không có	tên thành phố
»»»» state	string	false	không có	Mã tên tỉnh hoặc tiểu bang
»»»» continent_code	string	false	không có	mã lục địa
»»»» country_code	string	false	không có	Mã quốc gia hoặc vùng

Tìm kiếm thành phố

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys/search

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
country_code	query	string	true	Mã quốc gia hoặc vùng
state	query	string	true	Mã tiểu bang hoặc tỉnh

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[string]	false	không có	danh sách

Danh sách tiểu bang

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	danh sách
»»» name_zh_cn	string	false	không có	Tên quốc gia hoặc khu vực
»»» name_en	string	false	không có	Tên quốc gia hoặc khu vực
»»» continent_code	string	false	không có	mã lục địa
»»» country_code	string	false	không có	Mã quốc gia hoặc vùng
»»» items	[any]	false	không có	tỉnh hoặc tiểu bang
»»»» state	string	false	không có	Mã tên tỉnh hoặc tiểu bang
»»»» continent_code	string	false	không có	mã lục địa
»»»» country_code	string	false	không có	Mã quốc gia hoặc vùng

Tìm kiếm Tiểu bang/Tỉnh

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states/search

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
country_code	query	string	true	Mã quốc gia hoặc vùng

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[string]	false	không có	danh sách

Nhận danh sách IP tĩnh của trung tâm dữ liệu được chỉ định

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/ip/get-datacenter-assign-ip-list

Không được dùng nữa, bạn nên sử dụng /openapi/user-product/datacenter-isp-ip-list. Để tương thích với các client cũ, giao diện này sử dụng phương thức POST nhưng các tham số lọc đều được đọc từ truy vấn.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; bỏ qua khoảng trống cá nhân hoặc truyền một chuỗi trống; Khóa nhóm có thể được bỏ qua và phải nhất quán với Khóa khi được chuyển vào
area	query	string	false	Mã quốc gia
status	query	integer	false	0=tất cả, 1=hợp lệ, 2=đã hết hạn
trade_no	query	string	false	Số đơn hàng
created_at	query	array[string]	false	Để tạo phạm vi thời gian, thời gian bắt đầu và kết thúc phải được thông qua cùng một lúc.

Giá trị liệt kê

Parameter	Value
status	0
status	1
status	2

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Trích xuất danh sách IP tĩnh đã mua

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-static-ip

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
country_code	query	string	false	Mã quốc gia hoặc vùng
product_type	query	number	false	Loại sản phẩm, 25: IP dân dụng tĩnh, 14: IP trung tâm dữ liệu
trade_no	query	string	false	Lọc IP theo số đơn hàng
page	query	number	false	Số trang
size	query	number	false	Số lượng mỗi trang
status	query	number	false	Trạng thái, 1: hợp lệ, 2: không hợp lệ, 3: sắp hết hạn, 4: đang bảo trì

Giá trị liệt kê

Parameter	Value
product_type	14
product_type	25
status	1 - 2 - 3 - 4

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ

Lấy số lượng IP tĩnh đang bán trong khu vực

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
isp	query	integer	false	Lọc ISP, không lọc nếu không truyền (mặc định là 1 ngoại trừ trang 1/4/5)
asn	query	integer	false	Có trả về dữ liệu gói ASN hay không
exclusive	query	integer	false	Có tính theo hàng tồn kho độc quyền hay không

Detailed descriptions

isp: Lọc ISP, không lọc nếu không truyền (mặc định là 1 ngoại trừ trang 1/4/5)

giá trị	mô tả
0	Trung tâm dữ liệu IP tĩnh (IDC)
1	Trang chủ IP tĩnh (ISP)

asn: Có trả về dữ liệu gói ASN hay không

giá trị	mô tả
0	Không trả về dữ liệu gói ASN (mặc định)
1	Trả về dữ liệu gói ASN

exclusive: Có tính theo hàng tồn kho độc quyền hay không

giá trị	mô tả
0	Thống kê dựa trên tầm cỡ của người dùng/nhóm chia sẻ hiện tại (mặc định)
1	Loại trừ tất cả các IP được chỉ định và chỉ tính khoảng không quảng cáo có sẵn

Giá trị liệt kê

Parameter	Value
isp	0
isp	1
asn	0
asn	1
exclusive	0
exclusive	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[any]	false	không có	none
»»» code	string	true	không có	Mã quốc gia hoặc vùng
»»» number	integer	true	không có	số lượng

Nhận các quốc gia/khu vực được hỗ trợ bởi Host_pool

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

Truy vấn danh sách các quốc gia/khu vực được trang web hiện tại của dịch vụ hosting_pool hỗ trợ.

Giao diện này hướng đến kịch bản trích xuất ngẫu nhiên IP của trung tâm dữ liệu dựa trên các điểm lưu lượng truy cập và chỉ tính các quốc gia/khu vực dựa trên kho IP của trung tâm dữ liệu có sẵn tại địa điểm hiện tại.

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» code	string	true	không có	Mã quốc gia hoặc vùng, ISO 3166-1 alpha-2
»»» number	integer	true	không có	Số lượng IP trung tâm dữ liệu có sẵn tại địa điểm hiện tại
»»» name_zh_cn	string	false	không có	Quốc gia hoặc khu vực Tên tiếng Trung
»»» name_en	string	false	không có	Tên tiếng Anh của quốc gia hoặc khu vực
»»» square_flag	string	false	không có	URL hình ảnh cờ vuông

danh sách trắng IP

Danh sách danh sách trắng IP (GET /end-point/proxy-ip/list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
product_type	query	integer	false	Số loại gói

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» ip	string	false	không có	IP danh sách trắng
»»» remark	string	false	không có	Bình luận
»»» product_type	integer	false	không có	Loại gói
»»» created_at	string	false	không có	thời gian sáng tạo

Thêm danh sách trắng IP (POST /end-point/proxy-ip/add)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» ips	body	string	true	Các IP thuộc danh sách trắng cần được thêm vào, phân tách nhiều IP bằng dấu phẩy hoặc dòng mới.
» remark	body	string	false	Bình luận
» product_type	body	integer	false	Số loại gói
» user_product_id	body	integer	false	ID gói người dùng, bắt buộc khi loại gói là 11

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Xóa danh sách trắng IP (POST /end-point/proxy-ip/delete)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» ips	body	string	true	IP danh sách trắng cần xóa, nhiều IP được phân tách bằng dấu phẩy
» verify_type	body	string	false	Loại xác minh: điện thoại, email, wechat, totp
» verify_code	body	string	false	Mã xác minh

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Danh sách danh sách trắng IP (GET /end-point/white-ip/list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
product_type	query	integer	false	Số loại gói

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» ip	string	false	không có	IP danh sách trắng
»»» remark	string	false	không có	Bình luận
»»» product_type	integer	false	không có	Loại gói
»»» created_at	string	false	không có	thời gian sáng tạo

Thêm danh sách trắng IP (POST /end-point/white-ip/add)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» ips	body	string	true	Các IP thuộc danh sách trắng cần được thêm vào, phân tách nhiều IP bằng dấu phẩy hoặc dòng mới.
» remark	body	string	false	Bình luận
» product_type	body	integer	false	Số loại gói
» user_product_id	body	integer	false	ID gói người dùng, bắt buộc khi loại gói là 11

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Xóa danh sách trắng IP (POST /end-point/white-ip/delete)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» app_key	body	string	false	Khóa ủy quyền
» ips	body	string	true	IP danh sách trắng cần xóa, nhiều IP được phân tách bằng dấu phẩy
» verify_type	body	string	false	Loại xác minh: điện thoại, email, wechat, totp
» verify_code	body	string	false	Mã xác minh

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": null
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công
» msg	string	false	không có	thông báo trạng thái
» data	null	false	không có	none

Sửa đổi nhận xét danh sách trắng IP

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» ip	body	string(ipv4)	true	không có
» remark	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Làm mới bộ đệm xác thực danh sách trắng IP không gian tài nguyên hiện tại

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Hạn ngạch danh sách trắng IP cho các loại sản phẩm được chỉ định

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quota

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
product_type	query	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Hạn ngạch danh sách trắng IP cho tất cả các loại sản phẩm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quotas

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Truy vấn nhật ký giao thông

Lưu lượng truy cập được sử dụng gần đây được tóm tắt theo ngày

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» days	body	integer	false	không có
» product_type	body	integer	false	không có
» username	body	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Việc sử dụng lưu lượng truy cập lịch sử của tài khoản đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Xuất mức sử dụng lưu lượng truy cập hàng tháng của tài khoản đại lý

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Ví dụ phản hồi

Phản hồi 200

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Tệp CSV được mã hóa GBK	string

Tổng số lượng và lượng lưu lượng gói còn lại

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/flow-total

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
unit	query	string	false	không có

Giá trị liệt kê

Parameter	Value
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

biểu đồ tỷ lệ hàng ngày

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/rate-graph

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start	query	string(date)	false	không có
end	query	string(date)	false	không có
username	query	string	false	không có
user_product_id	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Thống kê lưu lượng bộ nhớ đệm hàng ngày

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/cache-total

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_time	query	string	false	không có
end_time	query	string	false	không có
product_type	query	integer	false	không có
username	query	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Việc sử dụng lưu lượng truy cập được tóm tắt theo ngày

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/total

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
app_key	query	string(password)	true	Khóa xác thực
start_time	query	string(Y-m-d H:i:s)	false	Thời gian bắt đầu, chính xác đến giây. Xin lưu ý rằng việc đăng nhập bị trì hoãn trong vòng 5 phút. Mặc định là trong vòng 7 ngày.
end_time	query	string(Y-m-d H:i:s)	false	Thời hạn, chính xác đến từng giây. Xin lưu ý rằng việc đăng nhập bị trì hoãn trong vòng 5 phút. Thời gian hiện tại mặc định.
username	query	string	false	Tên tài khoản phụ, truy vấn tất cả các tài khoản theo mặc định, tài khoản phụ có thể được chỉ định. Xin lưu ý rằng nếu bạn thêm tài khoản phụ có cùng tên, truy vấn này sẽ trả về tất cả hồ sơ sử dụng cho tài khoản đại lý có cùng tên.
product_type	query	number	false	Loại gói

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» day	string	false	không có	Ngày
»»» flow	integer	false	không có	Lưu lượng tiêu thụ, đơn vị KB

Nhật ký đại lý

Thống kê truy cập proxy IP của khách hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/list-v2

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_time	query	string(date)	false	không có
end_time	query	string(date)	false	không có
export	query	string	false	không có

Giá trị liệt kê

Parameter	Value
export	csv

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Kết quả thống kê JSON; Tệp CSV được trả về khi `export=csv`	string

Tỷ lệ lượt truy cập IP của khách hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/client-ip-proportion

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
start_time	query	string(date)	false	không có
end_time	query	string(date)	false	không có
export	query	string	false	không có

Giá trị liệt kê

Parameter	Value
export	csv

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Kết quả tỷ lệ JSON; Tệp CSV được trả về khi `export=csv`	string

Yêu cầu gói hàng

Danh sách các gói đã mua

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
app_key	query	string(password)	true	Khóa xác thực
trade_no	query	string	false	Mã đơn hàng, vui lòng nhập đầy đủ mã đơn hàng. Tìm kiếm mờ không được hỗ trợ.
page	query	number	false	Phân trang, mặc định: 1
size	query	number	false	Số trang hiển thị, mặc định: 20
product_type	query	number	false	Loại gói

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "created_at": "2022-05-13 12:14:15",
        "expired_at": "2022-05-13 12:14:15",
        "product_type": 9,
        "trade_no": "2022051312134339861461465434",
        "order": {
          "created_at": "2022-05-13 12:13:43",
          "pay_at": "2022-05-13 12:13:43",
          "title": "入门级"
        }
      }
    ],
    "page": 1,
    "page_size": 20,
    "total_count": 0,
    "total_page": 0
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	true	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	true	không có	thông báo trạng thái
» data	object	false	không có	none
»» list	[object]	false	không có	none
»»» id	integer	false	không có	Số gói
»»» created_at	string	false	không có	Thời gian hiệu lực của gói
»»» expired_at	string	false	không có	Thời gian hết hạn của gói. Sau khi hết hạn, lưu lượng không thể được sử dụng.
»»» product_type	productTypes	false	không có	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh
»»» trade_no	string	false	không có	Số giao dịch đặt hàng
»»» order	object	false	không có	none
»»»» created_at	string	false	không có	Thời gian tạo đơn hàng
»»»» pay_at	string	false	không có	Thời gian thanh toán đơn hàng
»»»» title	string	false	không có	Mô tả đơn hàng
»» page	integer	true	không có	Trang hiện tại
»» page_size	integer	false	không có	kích thước phân trang
»» total_count	integer	false	không có	Tổng số hồ sơ
»» total_page	integer	false	không có	Tổng số trang

Giá trị liệt kê

Thuộc tính	Giá trị
product_type	9
product_type	11
product_type	14
product_type	25

Tóm tắt dữ liệu gói người dùng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

Nhận thông tin tóm tắt thống kê về các gói người dùng, bao gồm tổng số tiền, số tiền hiệu dụng, số tiền sắp hết, số tiền đã hết hạn, v.v.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
app_key	query	string(password)	true	Khóa xác thực
product_type	query	integer	false	Loại sản phẩm, chỉ hỗ trợ 9 (gói lưu lượng động), 12 (gói lưu lượng IDC dài hạn)

Giá trị liệt kê

Parameter	Value
product_type	9
product_type	12

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Status Code 200

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» code	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản không được xác thực.
» msg	string	false	không có	thông báo trạng thái
» data	object	false	không có	none
»» total	integer	false	không có	Lưu lượng/Tổng khối lượng IP (đơn vị: KB)
»» total_count	integer	false	không có	Tổng số gói
»» effective	integer	false	không có	Số tiền còn hiệu lực (đơn vị: KB)
»» effective_count	integer	false	không có	Số gói hợp lệ
»» effective_total	integer	false	không có	Tổng số tiền hiệu dụng (đơn vị: KB)
»» effective_used	integer	false	không có	Lượng sử dụng hiệu quả (đơn vị: KB)
»» temporary	integer	false	không có	Tổng số tiền phải trả (phải trả trong vòng 7 ngày, đơn vị: KB)
»» temporary_count	integer	false	không có	Số gói hết hạn (hết hạn trong 7 ngày)
»» expired	integer	false	không có	Số tiền còn lại đã hết hạn (đơn vị: KB)
»» expired_count	integer	false	không có	Số gói hết hạn
»» used	integer	false	không có	Tổng số tiền sử dụng (đơn vị: KB)

Danh sách IP tĩnh

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» status	body	integer	false	không có
» page	body	integer	false	không có
» size	body	integer	false	không có
» user_product_id	body	integer	false	không có
» country_code	body	string	false	không có
» product_type	body	integer	false	không có
» ip	body	string(ipv4)	false	không có
» auto_renewal	body	integer	false	không có
» support_renewal	body	integer	false	không có
» remaining_days	body	integer	false	không có
» limit_days	body	integer	false	không có
» sort	body	string	false	không có
» remark	body	string	false	không có

Giá trị liệt kê

Parameter	Value
» auto_renewal	0
» auto_renewal	1
» support_renewal	0
» support_renewal	1
» sort	exp_asc
» sort	exp_desc

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Xóa các gói hết hạn

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Xóa các gói hết hạn theo đợt

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» ids	body	[integer]	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Sửa đổi nhận xét gói

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	không có
» remark	body	string	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Đặt các chuyển mạch UDP IP tĩnh theo đợt

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» ids	body	[integer]	true	không có
» udp	body	integer	true	không có

Giá trị liệt kê

Parameter	Value
» udp	0
» udp	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Quản lý gói

Thay đổi IP tĩnh của ISP trung tâm dữ liệu

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» id	body	integer	true	ID gói người dùng
» country_code	body	string	false	Mã quốc gia/khu vực mục tiêu; nếu không được thông qua, quốc gia/khu vực IP hiện tại sẽ được sử dụng trước tiên.
» ip	body	string	false	Lọc tiền tố IP đích

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Nhận hồ sơ thay thế IP tĩnh

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/ip-change-log

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	Mã định danh không gian tài nguyên; không gian cá nhân bỏ qua hoặc chuyển chuỗi trống
page	query	integer	false	không có
page_size	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Đặt công tắc gia hạn tự động cho một gói duy nhất

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_id	body	integer	true	không có
» status	body	integer	false	0=vô hiệu hóa, 1=kích hoạt

Giá trị liệt kê

Parameter	Value
» status	0
» status	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Đặt công tắc gia hạn tự động cho các gói theo đợt

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_ids	body	[integer]	true	không có
» status	body	integer	false	0=vô hiệu hóa, 1=kích hoạt

Giá trị liệt kê

Parameter	Value
» status	0
» status	1

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công; mỗi gói trả về kết quả xử lý một cách độc lập.	Inline

Lược đồ phản hồi

Đặt thông số tự động gia hạn mặc định cho các loại sản phẩm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal-default-config

Vượt qua ít nhất một trong các ngày_trước_hết hạn, ngưỡng lưu lượng, chu kỳ gia hạn_ngày; giá trị 0 có nghĩa là đặt lại cấu hình tương ứng.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» product_type	body	integer	true	không có
» days_before_expire	body	integer	false	không có
» traffic_threshold	body	integer	false	Đơn vị GB, chỉ được hỗ trợ vào ngày 12/9/24
» renewal_cycle_days	body	integer	false	Chỉ được hỗ trợ vào ngày 14/11/16/25 và phải là chu kỳ sản phẩm hiện tại được bán
» anonymous	body	object	false	không có
» anonymous	body	object	false	không có
» anonymous	body	object	false	không có

Giá trị liệt kê

Parameter	Value
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công, dữ liệu rỗng	Inline

Lược đồ phản hồi

Nhận thông số gia hạn tự động mặc định của loại sản phẩm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» product_type	body	integer	false	Nếu không được thông qua, tất cả các loại được hỗ trợ sẽ được trả về.

Giá trị liệt kê

Parameter	Value
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	24
product_type	25
source	user
source	system
source	user
source	system
traffic_source	user
traffic_source	system

Nhận cấu hình gia hạn tự động và xem trước gia hạn của một gói duy nhất

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_id	body	integer	true	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
time_unit	day
time_unit	hour
status	0
status	1

Nhận hồ sơ thực hiện gia hạn tự động

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	false	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» user_product_id	body	integer	false	Nếu không được thông qua, tất cả bản ghi trong không gian hiện tại sẽ được truy vấn.
» page	body	integer	false	không có
» size	body	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Giá trị liệt kê

Thuộc tính	Giá trị
trigger_type	0
trigger_type	1
status	1
status	2
status	3

Quản lý thanh toán

Kéo lên thanh toán đơn hàng

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
trade_no	query	string	true	không có
pm_id	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Bắt đầu thanh toán cho các đơn hàng chưa thanh toán được phát hành trong nền

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
body	body	object	true	không có
» team_id	body	any	false	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
»» anonymous	body	string	false	không có
»» anonymous	body	TeamPublicId	false	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
» trade_no	body	string	true	không có
» pay_method	body	integer	false	không có
» pm_id	body	integer	false	không có
» trade_type	body	string	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Hoạt động thành công	WebV1SuccessResponse

Trả trước phí tổng kiểm tra

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X POST https://api.proxylite.com/end-point/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/pay-check

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
trade_no	query	string	true	không có
pm_id	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Yêu cầu thành công	Inline

Lược đồ phản hồi

Trực tiếp hiển thị trang thanh toán web

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/pay/web-direct-pay

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
team_id	query	ResourceSpaceId	false	không có
trade_no	query	string	true	không có
pm_id	query	integer	false	không có

Ví dụ phản hồi

Phản hồi 200

"string"

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	Trang thanh toán HTML	string

Nhận danh sách các phương thức thanh toán (GET /end-point/payment/list)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/list

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
trade_no	query	string	false	Số đơn hàng - có thể được chuyển vào khi một số đơn hàng yêu cầu một phương thức thanh toán cụ thể
currency	query	string	false	đơn vị tiền tệ

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	đạt được thành công	Inline

Lược đồ phản hồi

Nhận danh sách các phương thức thanh toán (GET /end-point/payment/groups)

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
trade_no	query	string	false	Số đơn hàng - có thể được chuyển vào khi một số đơn hàng yêu cầu một phương thức thanh toán cụ thể

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	đạt được thành công	Inline

Lược đồ phản hồi

Tiếp thị

Tỷ lệ thưởng nạp tiền

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/activity/balance-recharge-gift-ratio

Tỷ lệ thưởng nạp tiền

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      null
    ]
  },
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	OK	Inline

Lược đồ phản hồi

Sản phẩm

Danh sách sản phẩm

Mẫu mã

# Bạn cũng có thể dùng wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

Nhận danh sách các gói có sẵn để mua trên trang web hiện tại và hỗ trợ lọc theo loại, thời hạn hiệu lực và các điều kiện khác.

Tham số

Tên	Vị trí	Kiểu	Bắt buộc	Mô tả
type	query	integer	false	Loại gói, xem mô tả liệt kê Product.type. Nếu không vượt qua, tất cả các loại sẽ được trả về.
parent_product_type	query	integer	false	Loại gói gốc, chỉ hợp lệ khi loại=19 (gia hạn IP), dùng để lọc các dòng sản phẩm: 14=trung tâm dữ liệu 25=dân cư
time_days	query	any	false	Lọc khoảng thời gian hiệu lực, hỗ trợ giá trị đơn hoặc mảng, chẳng hạn như 30 / [30,90,365]
show_type	query	any	false	Lọc kiểu hiển thị, hỗ trợ giá trị đơn hoặc mảng

Giá trị liệt kê

Parameter	Value
parent_product_type	14
parent_product_type	25

Ví dụ phản hồi

Phản hồi 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

Phản hồi

Trạng thái	Ý nghĩa	Mô tả	Lược đồ
200	OK	OK	Inline

Lược đồ phản hồi

Lược đồ

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	ID người dùng
username	string	true	không có	Tên người dùng
nickname	string	true	không có	Biệt danh
email	string	true	không có	Ràng buộc email
balance	string	true	không có	Số dư nạp lại, chuỗi thập phân
gift_balance	string	true	không có	Số dư tiền thưởng hiện tại, chuỗi thập phân
currency	string	true	không có	Tiền tệ của trang web
language	string	true	không có	Ngôn ngữ người dùng, ngôn ngữ trang web được sử dụng nếu không được cấu hình
timezone	string	true	không có	Múi giờ của người dùng, sử dụng múi giờ của trang web nếu không được định cấu hình

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
re_type	integer,string	false	không có	0 chi phí, 1 thu nhập
transaction_type	integer,string	false	không có	loại giao dịch
balance_type	integer,string	false	không có	Loại số dư
fee	string,number	false	không có	Thay đổi số tiền, đơn vị tiền tệ của trang web

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
user_id	integer,string	false	không có	Giao diện chi tiết trả về
start_time	string	false	không có	Y-m-d H:i:s; ngày không phải RFC 3339
end_time	string	false	không có	Y-m-d H:i:s; ngày không phải RFC 3339
status	string	false	không có	none
file_size	integer,string,null	false	không có	none
record_count	integer,string,null	false	không có	none
created_at	string	false	không có	Y-m-d H:i:s; ngày không phải RFC 3339
completed_at	string	false	không có	Y-m-d H:i:s; ngày không phải RFC 3339
file_url	string	false	không có	Sau khi hoàn thành sẽ trở về giao diện chi tiết
download_url	string	false	không có	Hoàn trả sau khi hoàn thành, địa chỉ tải xuống chữ ký có giá trị trong 24 giờ
error_message	string	false	không có	Nếu thất bại, giao diện chi tiết có thể quay lại

Giá trị liệt kê

Thuộc tính	Giá trị
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
coupon_id	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
type	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
status	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
source	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
title	string	false	không có	none
title_en	string	false	không có	none
description	string	false	không có	none
description_en	string	false	không có	none
start_amount	string,number,null	false	không có	none
start_amount_usd	string,number,null	false	không có	none
start_amount_hkd	string,number,null	false	không có	none
deduction_amount	string,number,null	false	không có	none
deduction_amount_usd	string,number,null	false	không có	none
deduction_amount_hkd	string,number,null	false	không có	none
discount_rate	string,number,null	false	không có	none
discount_ceiling_amount	string,number,null	false	không có	none
discount_ceiling_amount_usd	string,number,null	false	không có	none
discount_ceiling_amount_hkd	string,number,null	false	không có	none
created_at	string,null	false	không có	Y-m-d H:i:s
effect_at	string,null	false	không có	Y-m-d H:i:s
expired_at	string,null	false	không có	Y-m-d H:i:s
used_at	string,null	false	không có	Y-m-d H:i:s
product_types	string,null	false	không có	Các loại gói áp dụng
created_timestamp	integer,null	false	không có	none
effect_timestamp	integer,null	false	không có	none
expired_timestamp	integer,null	false	không có	none
used_timestamp	integer,null	false	không có	none
is_expired	boolean	false	không có	Giao diện danh sách trả về

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
title	string	false	không có	none
content	string	false	không có	Nội dung được hiển thị bằng ngôn ngữ được yêu cầu
type	integer,string	false	không có	Các giá trị cơ sở dữ liệu có thể được tuần tự hóa dưới dạng chuỗi
read_status	integer	false	không có	none
created_at	string	false	không có	Y-m-d H:i:s; ngày không phải RFC 3339
created_timestamp	integer	false	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
read_status	0
read_status	1

productTypes

Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	integer	false	không có	Loại gói, 9 gói giao thông dân cư động, 11 IP dân cư động, 14 IP trung tâm dữ liệu tĩnh, 25 IP dân cư tĩnh

Giá trị liệt kê

Thuộc tính	Giá trị
anonymous	9
anonymous	11
anonymous	14
anonymous	25

apiKey

"pa$$word"

Khóa API; được truyền bằng apiKeyAuth hoặc tham số yêu cầu được khai báo bởi thao tác

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	string(password)	false	không có	Khóa API; được truyền bằng apiKeyAuth hoặc tham số yêu cầu được khai báo bởi thao tác

responseCode

Mã trạng thái, 200 thành công, 3 app_key không hợp lệ

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	integer	false	không có	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ

responseMsg

"success"

response message

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	string	false	không có	response message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Thuộc tính

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Thuộc tính

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
code	integer	true	không có	none
msg	string	true	không có	none
data	object,array,string,number,boolean,null	true	không có	Dữ liệu nghiệp vụ, loại cụ thể được xác định bởi giao diện
request_id	string	true	không có	Yêu cầu ID theo dõi liên kết

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
code	integer	true	không có	Mã lỗi kinh doanh

not

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	any	false	không có	none

continued

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
msg	string	true	không có	Mô tả lỗi
data	object,array,null	true	không có	Lỗi dữ liệu bổ sung, null nếu không có dữ liệu bổ sung
request_id	string	true	không có	Yêu cầu ID theo dõi liên kết

TeamPublicId

"A1b2C3d4E5f6"

Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	string	false	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

ResourceSpaceId

"A1b2C3d4E5f6"

Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số

Thuộc tính

oneOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	string	false	không có	none

xor

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	TeamPublicId	false	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
name	string	true	không có	Tên đội
super_admin_user_id	integer	true	không có	ID người dùng quản trị viên cấp cao
status	integer	true	không có	Trạng thái đội: 0=bị vô hiệu hóa, 1=hợp lệ, 2=đang giải tán, 3=đã giải tán
current_role	integer,null	true	không có	Vai trò của người dùng hiện tại trong nhóm; null nếu không thể xác định được
dissolving_at	string,null	true	không có	Bắt đầu thời gian giải thể
dissolved_at	string,null	true	không có	Thời gian hoàn thành giải thể
created_at	string	true	không có	thời gian sáng tạo
updated_at	string	true	không có	Thời gian cập nhật

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	ID gói người dùng
user_id	integer	true	không có	ID người dùng của chủ sở hữu tài nguyên
team_id	ResourceSpaceId	true	không có	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
team_user_id	integer	true	không có	Thực tế tạo ID người dùng thành viên
product_id	integer	true	không có	ID sản phẩm
product_type	integer	true	không có	loại sản phẩm
parent_product_type	integer	true	không có	Loại sản phẩm gốc
status	integer	true	không có	Trạng thái gói hàng
total_amount	integer(int64)	true	không có	tổng số tiền
remain	integer(int64)	true	không có	Số tiền còn lại
bandwidth	integer	false	không có	Băng thông (Mbps); chỉ được trả về bởi sản phẩm_type=19 hoặc 11
concurrency	integer	false	không có	Số lượng đồng thời; chỉ có sản phẩm_type=11 được trả về
expired_at	string,null	true	không có	Thời gian hết hạn
created_at	string	true	không có	thời gian sáng tạo
ip	string	false	không có	Địa chỉ IP tĩnh; chỉ có sản phẩm_type=19 trả về
country_code	string	false	không có	Mã quốc gia IP tĩnh; chỉ có sản phẩm_type=19 trả về
country_name	string	false	không có	Tên quốc gia IP tĩnh; chỉ được trả về bởi sản phẩm_type=19
asn	string	false	không có	ASN IP tĩnh; chỉ có sản phẩm_type=19 được trả về
port	integer	false	không có	Cổng proxy IP tĩnh; chỉ được trả về bởi sản phẩm_type=19

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

Các trường thống kê gói nhất quán với /web_v1/user/info; hồ sơ hủy bỏ, hoàn tiền hoặc xóa mềm không được đưa vào bản tóm tắt; ngoại trừ team_id và Product_types, chỉ các trường tương ứng với loại sản phẩm được trang hiện tại hỗ trợ mới được trả về

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
product_types	[integer]	true	không có	Không gian tài nguyên nhóm chưa bị hủy hoặc xóa mềm và loại gói được trang hiện tại hỗ trợ
product_residence_remain_count	integer(int64)	false	không có	Dòng dư loại 9
product_residence_total_count	integer(int64)	false	không có	Tổng lưu lượng loại 9
pdrue2_timestamp	integer(int64)	false	không có	Dấu thời gian hết hạn mới nhất loại 11; 0 khi không có gói đội
remain	integer,string	false	không có	Loại 17 Số lượng còn lại
total_amount	integer,string	false	không có	Loại 17 Tổng số lượng
scraping_remain	integer(int64)	false	không có	Gõ 18 lần còn lại
scraping_total_amount	integer(int64)	false	không có	Tổng số lần gõ 18
scraping_timestamp	string	false	không có	Loại 18 thời gian hết hạn muộn nhất; "-" khi không có gói hàng
scraping_timestamp2	integer(int64)	false	không có	Dấu thời gian hết hạn mới nhất của loại 18
common_scraping_remain	integer(int64)	false	không có	Gõ 29 lần còn lại
common_scraping_total_amount	integer(int64)	false	không có	Loại 29 Tổng số lần
common_scraping_timestamp	string	false	không có	Loại 29 thời gian hết hạn muộn nhất; "-" khi không có gói hàng
common_scraping_timestamp2	integer(int64)	false	không có	Dấu thời gian hết hạn mới nhất của loại 29
pdidcr_count	integer	false	không có	Số lượng gói hợp lệ loại 12
pdidcr_total	integer	false	không có	Tổng số gói loại 12
pdidcr_traffic_remain	integer(int64)	false	không có	Dòng dư loại 12
pdidcr_traffic_total	integer(int64)	false	không có	Tổng lưu lượng loại 12
p_sitai_ip_count	integer	false	không có	Loại 13 Số IP hợp lệ
p_sitai_ip	integer	false	không có	Loại 13 Số lượng gói hợp lệ
p_sitai_ip_total	integer	false	không có	Tổng số gói loại 13
p_sitai_remain	integer(int64)	false	không có	Dòng dư loại 13/24
p_sitai_total	integer(int64)	false	không có	Tổng lưu lượng loại 13/24
pdidc_count	integer	false	không có	Loại 14 Số lượng gói hợp lệ
pdidc_total	integer	false	không có	Tổng số gói loại 14
pdidc_ip_count	integer	false	không có	Loại 14 Số IP hợp lệ
pdidc_ip_all_count	integer	false	không có	Tổng số IP loại 14
pdispr_count	integer	false	không có	Loại 15 Số lượng gói hợp lệ
pdispr_total	integer	false	không có	Tổng số gói loại 15
pdispr_traffic_remain	integer(int64)	false	không có	Dòng dư loại 15
pdispr_traffic_total	integer(int64)	false	không có	Tổng lưu lượng loại 15
product_datacenter_isp_traffic_ip_count	integer	false	không có	Loại 16 Số IP hợp lệ
product_datacenter_isp_traffc_ip	integer	false	không có	Loại 16 Số lượng gói hợp lệ; Cách viết tương thích về mặt lịch sử
product_datacenter_isp_traffc_ip_total	integer	false	không có	Tổng số gói thầu loại 16; Cách viết tương thích về mặt lịch sử
product_datacenter_isp_traffic_ip	integer	false	không có	Loại 16 Số lượng gói hợp lệ
product_datacenter_isp_traffic_ip_total	integer	false	không có	Tổng số gói loại 16
product_datacenter_isp_traffc_remain	integer(int64)	false	không có	Giao thông dư thừa loại 16/24; chính tả tương thích về mặt lịch sử
product_datacenter_isp_traffc_total	integer(int64)	false	không có	Tổng lưu lượng loại 16/24; chính tả tương thích về mặt lịch sử
product_datacenter_isp_traffic_remain	integer(int64)	false	không có	Dòng dư loại 16/24
product_datacenter_isp_traffic_total	integer(int64)	false	không có	Tổng lưu lượng loại 16/24
product_datacenter_isp_ip	integer	false	không có	Số lượng gói hợp lệ loại 21 hoặc 25
product_datacenter_isp_ip_total	integer	false	không có	Tổng cộng loại 21 hoặc 25 gói
product_datacenter_isp_ip_count	integer	false	không có	Nhập 21 hoặc 25 Số IP hợp lệ
product_datacenter_isp_ip_all_count	integer	false	không có	Tổng số IP loại 21 hoặc 25
product_datacenter_isp_ip_traffic_remain	integer(int64)	false	không có	Loại 21 tương ứng với luồng còn lại loại 24
product_datacenter_isp_ip_traffic_total	integer(int64)	false	không có	Loại 21 tương ứng với tổng lưu lượng loại 24
product_agent_residence_remain_count	integer(int64)	false	không có	Dòng dư loại 22
product_agent_residence_total_count	integer(int64)	false	không có	Tổng lưu lượng loại 22
product_serp_remain	integer(int64)	false	không có	Gõ 27 lần còn lại
product_serp_total	integer(int64)	false	không có	Loại 27 Tổng số lần
product_serp_timestamp	string	false	không có	Loại 27 thời gian hết hạn muộn nhất; "-" khi không có gói hàng
product_serp_timestamp2	integer(int64)	false	không có	Dấu thời gian hết hạn mới nhất loại 27
product_video_remain	integer(int64)	false	không có	Dòng dư loại 28
product_video_total	integer(int64)	false	không có	Tổng lưu lượng loại 28
product_video_timestamp	string	false	không có	Loại 28 thời gian hết hạn muộn nhất; "-" khi không có gói hàng
product_video_timestamp2	integer(int64)	false	không có	Loại 28 dấu thời gian hết hạn mới nhất

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

Ví nhóm, tách biệt với số dư cá nhân của quản trị viên cấp cao; số tiền sử dụng đơn vị tiền tệ mặc định của trang web hiện tại, có tối đa 4 chữ số thập phân.

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
balance	number(double)	true	không có	Số dư nhóm hiện có
total_recharge_fee	number(double)	true	không có	Số tiền gốc nạp lại của nhóm chưa chi tiêu hiện tại, không bao gồm số tiền chuyển số dư cá nhân
updated_at	string	true	không có	Lần thay đổi ví cuối cùng

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	none
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
operator_user_id	integer	true	không có	Nhà điều hành, số tiền hoàn lại của hệ thống là 0
creator	TeamCreator	false	không có	none
direction	integer	true	không có	0=chi phí, 1=thu nhập
transaction_type	integer	true	không có	1=Nạp tiền vào tài khoản, 2=Chuyển từ số dư cá nhân, 3=Sử dụng số dư, 4=Hoàn tiền hoặc hoàn tiền nạp lại, 5=Chuyển về số dư cá nhân
amount	number(double)	true	không có	Lượng thay đổi này, hướng được thể hiện bằng hướng
after_balance	number(double)	true	không có	Số dư ví nhóm sau khi thay đổi
link_id	integer	true	không có	ID đơn hàng liên quan; khi số dư cá nhân được chuyển, đó là ID người dùng vận hành
request_id	string	true	không có	none
remark	string	true	không có	none
created_at	string	true	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
user_id	integer	true	không có	ID người dùng của nhà điều hành; hoạt động của hệ thống là 0
display_name	string	true	không có	Hiển thị tên, lấy biệt hiệu, tên người dùng, email và số điện thoại di động theo thứ tự
nickname	string	true	không có	none
username	string	true	không có	none
email	string	true	không có	Quan điểm của người không phải là quản trị viên là giá trị giải mẫn cảm
phone	string	true	không có	Quan điểm của người không phải là quản trị viên là giá trị giải mẫn cảm

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	Team	false	không có	none

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[Team]	true	không có	none
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» page_size	integer	true	không có	none

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[TeamMember]	true	không có	none
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» page_size	integer	true	không có	none

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[TeamPerson]	true	không có	none
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» page_size	integer	true	không có	none

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	TeamAsset	false	không có	none

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	TeamProductInfo	false	không có	Các trường thống kê gói nhất quán với /web_v1/user/info; hồ sơ hủy bỏ, hoàn tiền hoặc xóa mềm không được đưa vào bản tóm tắt; ngoại trừ team_id và Product_types, chỉ các trường tương ứng với loại sản phẩm được trang hiện tại hỗ trợ mới được trả về

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	TeamWallet	false	không có	Ví nhóm, tách biệt với số dư cá nhân của quản trị viên cấp cao; số tiền sử dụng đơn vị tiền tệ mặc định của trang web hiện tại, có tối đa 4 chữ số thập phân.

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[TeamWalletRecord]	true	không có	none
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» page_size	integer	true	không có	none

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[TeamAsset]	true	không có	none
»» total	integer	true	không có	none
»» page	integer	true	không có	none
»» page_size	integer	true	không có	none

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	API Key ID
api_key	string	true	không có	Phản hồi tạo là Khóa hoàn chỉnh; danh sách nhóm là giá trị bị che
team_user_id	integer	true	không có	Khóa nhóm thực sự chứa ID thành viên và khóa cá nhân là 0
remark	string	true	không có	Bình luận
status	integer	true	không có	0=vô hiệu hóa, 1=kích hoạt
created_at	string	true	không có	thời gian sáng tạo
updated_at	string,null	false	không có	Thời gian cập nhật

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
invoice_code	string	false	không có	none
name	string	false	không có	none
org_name	string	false	không có	none
first_name	string	false	không có	none
last_name	string	false	không có	none
phone	string	false	không có	none
email	string(email)	false	không có	none
role_type	integer	false	không có	none
invoice_type	integer	false	không có	none
vat_id	string	false	không có	none
tax_no	string	false	không có	none
address_country	string	false	không có	none
address_city	string	false	không có	none
address_line1	string	false	không có	none
address_line2	string	false	không có	none
address_postal_code	string	false	không có	none
bank_name	string	false	không có	none
bank_account	string	false	không có	none
is_def	boolean	false	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
team_id	ResourceSpaceId	false	không có	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
user_product_ids	any	true	không có	Mảng ID gói người dùng, cũng tương thích với các chuỗi được phân tách bằng dấu phẩy tiếng Anh

oneOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	[integer]	false	không có	none

xor

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	string	false	không có	none

continued

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
user_coupon_id	integer	false	không có	none
coupon_sn	string	false	không có	none

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	ID lời mời
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
inviter_user_id	integer	true	không có	ID người dùng của người mời
invitee_user_id	integer	true	không có	ID người dùng được mời, 0 nếu chưa có người dùng đã đăng ký nào được khớp
invite_type	integer	true	không có	Loại lời mời: 1=người dùng đã đăng ký, 2=email, 3=số điện thoại di động
invite_country_code	integer	true	không có	Mã quốc gia hoặc vùng của số điện thoại di động, 0 cho lời mời đến số điện thoại không phải điện thoại di động
invite_target	string	true	không có	Mục tiêu lời mời được tiêu chuẩn hóa; người dùng đã đăng ký là người dùng:{user_id}
delivery_type	integer	true	không có	Kênh gửi ban đầu: 1=người dùng đã đăng ký, 2=email, 3=số điện thoại di động; kênh ban đầu sẽ được giữ lại khi email hoặc số điện thoại di động khớp với người dùng đã đăng ký
role	integer	true	không có	Vai trò mục tiêu: 2=quản trị viên, 3=thành viên bình thường
status	integer	true	không có	Trạng thái lời mời: 0=đang chờ xử lý, 1=được chấp nhận, 2=bị từ chối, 3=đã hủy, 4=đã hết hạn
accepted_by_user_id	integer	true	không có	ID người dùng chấp nhận, 0 nếu không được chấp nhận
expired_at	string	true	không có	Thời gian hết hạn, định dạng YYYY-MM-DD HH:mm:ss
accepted_at	string,null	true	không có	Thời gian chấp nhận
rejected_at	string,null	true	không có	thời gian từ chối
cancelled_at	string,null	true	không có	Thời gian hủy
created_at	string	true	không có	Thời gian tạo, định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
team_member_id	integer	true	không có	ID thành viên
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
user_id	integer	true	không có	ID người dùng thành viên
role	integer	true	không có	Vai trò: 1=quản trị viên cấp cao, 2=quản trị viên, 3=thành viên thông thường, 4=thành viên tài chính
status	integer	true	không có	Trạng thái thành viên: 0=bị vô hiệu hóa, 1=hợp lệ, 2=đã thoát, 3=đã xóa
joined_at	string,null	true	không có	Thời gian tham gia, định dạng YYYY-MM-DD HH:mm:ss
nickname	string	true	không có	Biệt danh thành viên
username	string	true	không có	tên người dùng thành viên

Giá trị liệt kê

Thuộc tính	Giá trị
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
record_type	string	true	không có	Loại bản ghi; thành viên là thành viên hợp lệ, lời mời là lời mời đang chờ xử lý
record_id	integer	true	không có	ID thành viên hoặc ID lời mời
team_id	TeamPublicId	true	không có	Logo công khai của đội, ký tự đầu tiên là chữ cái ASCII, các ký tự còn lại chỉ chứa chữ cái và số ASCII; khóa chính số của cơ sở dữ liệu không được cấp
user_id	integer	true	không có	ID người dùng, người dùng được mời chưa đăng ký là 0
inviter_user_id	integer	true	không có	ID người dùng của người mời, hồ sơ thành viên là 0
invite_type	integer	true	không có	Loại lời mời, hồ sơ thành viên là 0
invite_country_code	integer	true	không có	Số điện thoại di động quốc gia hoặc mã vùng, hồ sơ thành viên là 0
invite_target	string	true	không có	Mục tiêu lời mời, bản ghi thành viên là một chuỗi trống
delivery_type	integer	true	không có	Kênh phân phối ban đầu, hồ sơ thành viên là 0
role	integer	true	không có	Vai trò: 1=quản trị viên cấp cao, 2=quản trị viên, 3=thành viên thông thường, 4=thành viên tài chính
status	integer	true	không có	thành viên được cố định là 1, lời mời được cố định là 0
display_name	string	true	không có	Hiển thị tên thống nhất, lấy biệt danh, tên người dùng, email và số điện thoại di động theo thứ tự; sử dụng các giá trị đã được giải mẫn cảm cho thông tin liên hệ từ góc độ của các thành viên bình thường
nickname	string	true	không có	Biệt danh của thành viên hoặc người dùng được mời đã đăng ký
username	string	true	không có	Thành viên hoặc tên người dùng được mời đã đăng ký
email	string	true	không có	Thư điện tử; quản trị viên cấp cao và quản trị viên trả về giá trị hoàn chỉnh, thành viên bình thường trả về giá trị giải mẫn cảm bằng dấu hoa thị
phone	string	true	không có	Số điện thoại di động; quản trị viên cấp cao và quản trị viên trả về giá trị đầy đủ và các thành viên bình thường trả về giá trị đã được giải mẫn cảm bằng dấu hoa thị.
joined_at	string,null	true	không có	Thời gian gia nhập thành viên, bản ghi lời mời là null
expired_at	string,null	true	không có	Thời gian hết hạn của lời mời, hồ sơ thành viên là null
created_at	string	true	không có	Ghi thời gian tạo, định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	TeamInvitation	false	không có	none

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	TeamMember	false	không có	none

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» invitation	TeamInvitation	true	không có	none
»» invitation_token	string	true	không có	Mã thông báo lời mời bằng văn bản rõ ràng, chỉ dành riêng cho các khách hàng hiện có tương thích; khách hàng mới sử dụng Invitation_url trực tiếp
»» invitation_url	string(uri)	true	không có	Liên kết xử lý giao diện người dùng chứa mã thông báo lời mời
»» notification_channels	TeamInvitationNotificationChannels	true	không có	none

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
email	string	false	không có	Kết quả kênh email
sms	string	false	không có	Kết quả kênh SMS
site_inner_message	string	false	không có	Kết quả kênh tin nhắn của trang web

Giá trị liệt kê

Thuộc tính	Giá trị
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» team_name	string	true	không có	Tên đội
»» role	integer	true	không có	vai trò mục tiêu
»» status	integer	true	không có	trạng thái lời mời
»» expired_at	string	true	không có	Thời gian hết hạn, định dạng YYYY-MM-DD HH:mm:ss

Giá trị liệt kê

Thuộc tính	Giá trị
role	2
role	3
status	0
status	1
status	2
status	3
status	4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» invitation	TeamInvitation	true	không có	none
»» invitation_url	string(uri)	true	không có	Liên kết xử lý lời mời mới; liên kết cũ không còn hoạt động
»» notification_channels	TeamInvitationNotificationChannels	true	không có	none

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Thuộc tính

allOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	WebV1SuccessResponse	false	không có	none

and

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
anonymous	object	false	không có	none
» data	object	false	không có	none
»» list	[TeamInvitation]	true	không có	none
»» total	integer	true	không có	tổng số lời mời
»» page	integer	true	không có	Số trang hiện tại
»» page_size	integer	true	không có	số thực tế trên mỗi trang

User

{
  "id": 0,
  "email": "[email protected]",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
email	string(email)	false	không có	none
phone	string	false	không có	none
balance	number(float)	false	không có	none
status	integer	false	không có	none
is_real_name	boolean	false	không có	none
created_at	string(date-time)	false	không có	none

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	ID đơn hàng
trade_no	string	false	không có	Số đơn hàng nội bộ
out_trade_no	string	false	không có	Số đơn đặt hàng bên ngoài
product_id	integer	false	không có	Mã gói
product_type	integer	false	không có	Loại gói, xem liệt kê loại sản phẩm
amount	integer	false	không có	Số lượng mua
unit_price	number(float)	false	không có	đơn giá
total_fee	number(float)	false	không có	Tổng giá trị đơn hàng (không bao gồm chiết khấu và phí xử lý)
goods_fee	number(float)	false	không có	Giá sản phẩm (đã bao gồm chiết khấu, chưa bao gồm phí xử lý)
pay_fee	number(float)	false	không có	Số tiền thực tế thanh toán (bao gồm chiết khấu và phí xử lý)
discount_fee	number(float)	false	không có	Số tiền chiết khấu
handling_fee	number(float)	false	không có	phí xử lý
refund_fee	number(float)	false	không có	Số tiền hoàn lại
pm_id	integer	false	không có	ID phương thức thanh toán (từ /openapi/thanh toán/danh sách)
pm_title	string	false	không có	Tên phương thức thanh toán
pm_logo	string	false	không có	URL biểu trưng của phương thức thanh toán
status	integer	false	không có	Trạng thái đơn hàng
title	string	false	không có	Tiêu đề gói
detail	string	false	không có	Mô tả gói
region_desc	string	false	không có	Mô tả đặc điểm kỹ thuật khu vực
pay_at	string(date-time)	false	không có	thời gian thanh toán
pay_timestamp	integer	false	không có	Dấu thời gian thanh toán
created_at	string(date-time)	false	không có	thời gian sáng tạo
pay_fee_status	integer	false	không có	Trạng thái thanh toán dài và ngắn: 0 bình thường 1 thanh toán dài (thanh toán vượt mức) 2 thanh toán ngắn
invoice	object	false	không có	Thông tin hóa đơn (chỉ có giá trị đối với đơn hàng thanh toán trực tuyến)
» name	string	false	không có	tên đầy đủ
» org_name	string	false	không có	Tên công ty
» first_name	string	false	không có	none
» last_name	string	false	không có	none
» phone	string	false	không có	none
» email	string(email)	false	không có	none
» role_type	integer	false	không có	1 người 2 công ty
» vat_id	string	false	không có	Mã số thuế
» address_country	string	false	không có	none
» address_city	string	false	không có	none
» address_line1	string	false	không có	none
» address_line2	string	false	không có	none
» address_postal_code	string	false	không có	none

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

Đặt hàng kết quả kiểm tra trước

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
product_id	integer	false	không có	Mã gói
amount	integer	false	không có	số lượng
discount_fee	number(float)	false	không có	Số tiền chiết khấu
total_fee	number(float)	false	không có	Tổng số đơn đặt hàng
pay_fee	number(float)	false	không có	Số tiền thực trả
product_type	integer	false	không có	Loại gói
title	string	false	không có	Tiêu đề gói
detail	string	false	không có	Mô tả gói
ip_result	[object]	false	không có	Kết quả gia hạn IP hàng loạt (chỉ trả về khi gia hạn IP)
» ip	string	false	không có	none
» price	number(float)	false	không có	none
» country_code	string	false	không có	none
» current_time	string(date-time)	false	không có	none
» renewal_time	string(date-time)	false	không có	none
» country	object	false	không có	none
»» name_zh_cn	string	false	không có	none
»» flag	string	false	không có	URL cờ vòng tròn
»» square_flag	string	false	không có	URL cờ vuông

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	Mã gói
title	string	false	không có	Tiêu đề chính của gói
type	integer	false	không có	Loại gói
show_type	integer	false	không có	Loại hiển thị: 1 Bình thường 2 Khuyến nghị lớn 3 Không có sẵn để mua (cần tùy chỉnh) 4 Dùng thử
status	integer	false	không có	Tình trạng: 1 trên kệ, 0 ngoài kệ
price	number(float)	false	không có	giá nhân dân tệ
usd_price	number(float)	false	không có	giá đô la
price_hkd	number(float)	false	không có	Giá đô la Hồng Kông
original_price	number(float)	false	không có	Giá gốc (CNY)
original_usd_price	number(float)	false	không có	Giá gốc (USD)
original_price_hkd	number(float)	false	không có	Giá gốc (HKD)
local_price	number(float)	false	không có	Giá địa phương (phụ thuộc vào ưa thích_currency)
local_original_price	number(float)	false	không có	Giá gốc địa phương hóa (phụ thuộc vào ưa thích_currency)
preferred_currency	string	false	không có	Nên hiển thị loại tiền tệ như usd/cny/hkd
support_currencies	string	false	không có	Danh sách các loại tiền tệ được hỗ trợ, được phân tách bằng dấu phẩy, chẳng hạn như usd, cny
flow_value	number(float)	false	không có	Lưu lượng mặc định của gói dữ liệu (GB)
flow_give	number(float)	false	không có	Lưu lượng truy cập miễn phí (GB)
balance_give	number(float)	false	không có	Tiền thưởng nạp lại số dư
balance_value	number(float)	false	không có	Số tiền nạp
time_validity	number(float)	false	không có	Thời hạn hiệu lực mặc định của các gói tiêu chuẩn
time_price	number(float)	false	không có	Giá gói tiêu chuẩn trên mỗi IP
time_days	integer	false	không có	Số ngày có hiệu lực, chẳng hạn như 30/90/180/365
tip1	string	false	không có	Mô tả nhãn 1
tip2	string	false	không có	Mô tả nhãn 2
introduce	[string]	false	không có	Danh sách văn bản giới thiệu
region_list_id	integer	false	không có	ID khu vực
renew_product_list	string	false	không có	Danh sách ID gói có thể gia hạn (được phân tách bằng dấu phẩy)
parent_product_type	integer	false	không có	Loại gói gốc (hợp lệ khi loại=19): 14 hoặc 25
total_count	integer	false	không có	Tổng hàng tồn kho, 0 có nghĩa là không có giới hạn
remain_count	integer	false	không có	hàng còn lại
extension_of_time_days	[integer]	false	không có	Danh sách bội số thời lượng. Nếu nó trống hoặc chỉ chứa 1 thì có nghĩa là nó không được hỗ trợ.
time_days_price_rate	number(float)	false	không có	Hệ số giá thời hạn, giá × (1 + (bội số 1) × tỷ lệ)
desc	object	false	không có	Thông tin mô tả gói
» subtitle	string	false	không có	phụ đề
» flow_value	number(float)	false	không có	none
» flow_give	number(float)	false	không có	none
» balance_give	number(float)	false	không có	none
» time_validity	number(float)	false	không có	none
» time_price	number(float)	false	không có	none
» tip1	string	false	không có	none
» tip2	string	false	không có	none
» introduce	[string]	false	không có	none
sku	object	false	không có	Tham số đặc tả (trả về khi loại=11)
» bandwidth_list	[object]	false	không có	Danh sách đặc tả băng thông
»» id	integer	false	không có	none
»» value	integer	false	không có	Giá trị băng thông (Mbps)
»» price	number(float)	false	không có	none
»» price_usd	number(float)	false	không có	none
»» price_hkd	number(float)	false	không có	none
» duration_list	[object]	false	không có	Danh sách đặc tả thời lượng
»» id	integer	false	không có	none
»» value	integer	false	không có	Thời lượng (ngày)
»» price	number(float)	false	không có	none
»» price_usd	number(float)	false	không có	none
»» price_hkd	number(float)	false	không có	none
» concurrency_list	[object]	false	không có	Danh sách đặc tả đồng thời
»» id	integer	false	không có	none
»» value	integer	false	không có	Số lượng đồng thời
»» price	number(float)	false	không có	none
»» price_usd	number(float)	false	không có	none
»» price_hkd	number(float)	false	không có	none

WhiteIp

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
ip	string	false	không có	none
remark	string	false	không có	none
created_at	string(date-time)	false	không có	none

WhitelistAccount

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
username	string	false	không có	none
limit	integer	false	không có	none
used	integer	false	không có	none
status	integer	false	không có	none

Coupon

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
name	string	false	không có	none
code	string	false	không có	none
discount	number(float)	false	không có	none
expire_time	string(date-time)	false	không có	none

Article

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
title	string	false	không có	none
content	string	false	không có	none
created_at	string(date-time)	false	không có	none

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
total	integer	false	không có	none
page_no	integer	false	không có	none
page_size	integer	false	không có	none
total_pages	integer	false	không có	none

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

Ảnh chụp nhanh cấu hình tự động gia hạn của một gói

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	none
user_id	integer	false	không có	none
team_id	ResourceSpaceId	false	không có	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
team_user_id	integer	false	không có	none
product_type	integer	false	không có	none
left_traffic	integer	false	không có	Trường không được dùng nữa
left_days	integer	false	không có	Trường không được dùng nữa
user_product_id	integer	false	không có	none
product_id	integer	false	không có	Trường không được dùng nữa
status	integer	false	không có	0=vô hiệu hóa, 1=kích hoạt
currency	string	false	không có	none
agreed_price	number	false	không có	Tổng giá thỏa thuận
agreed_bandwidth_price	number	false	không có	Đơn giá băng thông thống nhất cho Gói 11
agreed_concurrency_price	number	false	không có	Thống nhất đơn giá đồng thời cho Gói thầu 11
bandwidth_id	integer	false	không có	none
concurrency_id	integer	false	không có	none
duration	integer	false	không có	Thời gian gia hạn, ngày đơn vị
renew_product_id	integer	false	không có	none
days_before_expire	integer	false	không có	none
traffic_threshold	integer	false	không có	Ngưỡng lưu lượng, đơn vị giá trị cơ sở dữ liệu KB
parent_product_type	integer	false	không có	none
created_at	string	false	không có	none
updated_at	string	false	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
status	0
status	1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	none
user_id	integer	true	không có	none
team_id	ResourceSpaceId	true	không có	Xác định không gian tài nguyên công cộng; bỏ qua team_id hoặc chuyển một chuỗi trống khi yêu cầu không gian cá nhân và một chuỗi trống khi phản hồi không gian cá nhân; cả số 0 và chuỗi "0" đều không hợp lệ và không gian nhóm sử dụng nhận dạng công khai của nhóm gồm 6-12 chữ số
team_user_id	integer	true	không có	none
config_id	integer	true	không có	none
user_product_id	integer	true	không có	none
product_type	integer	true	không có	none
renew_product_id	integer	true	không có	none
order_id	integer	true	không có	none
fee	number	true	không có	none
currency	string	true	không có	none
before_expired_at	string,null	false	không có	none
after_expired_at	string,null	false	không có	none
before_remain	integer(int64)	true	không có	none
after_remain	integer(int64)	true	không có	none
trigger_type	integer	true	không có	0=Trước khi hết hạn, 1=Không đủ lưu lượng truy cập
status	integer	true	không có	1=thành công, 2=bị thu hồi, 3=thất bại
revoke_at	string,null	false	không có	none
revoke_remark	string	true	không có	none
created_at	string	true	không có	none
updated_at	string	true	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
trigger_type	0
trigger_type	1
status	1
status	2
status	3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
type	string	true	không có	none
start_at	string	true	không có	none
end_at	string	true	không có	none
target_expired_at	string	true	không có	none
timezone	string	true	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
type	current
type	next

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	false	không có	ID chi tiết thanh toán lịch sử
user_product_id	integer	true	không có	none
product_id	integer	true	không có	none
product_type	integer	true	không có	none
parent_product_type	integer	true	không có	none
title	string	true	không có	none
expired_at	string	true	không có	none
target_expired_at	string	true	không có	none
renew_days	integer	true	không có	none
unit_month_price	number	false	không có	none
pay_fee	number	true	không có	none
currency	string	true	không có	none
bandwidth	integer	false	không có	none
bandwidth_mbsp	number	false	không có	Giá trị chuyển đổi băng thông
concurrency	integer	false	không có	none
ip	string	false	không có	Trả về gói IP tĩnh
country_code	string	false	không có	Trả về gói IP tĩnh
paid_at	string,null	false	không có	none
refunded_at	string,null	false	không có	none
created_at	string	false	không có	none
updated_at	string	false	không có	none

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
id	integer	true	không có	none
invoice_no	string	true	không có	none
invoice_amount	number	true	không có	none
invoice_download_url	string	true	không có	none
status	integer	true	không có	none
remark	string	true	không có	none
order_ids	[integer]	true	không có	none
created_at	integer	true	không có	Dấu thời gian Unix
invoice_info	any	true	không có	none

oneOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	object	false	không có	none
»» invoice_code	string	true	không có	none
»» name	string	true	không có	none
»» org_name	string	true	không có	none
»» role_type	integer	true	không có	none
»» invoice_type	integer	true	không có	none

xor

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	null	false	không có	none

Giá trị liệt kê

Thuộc tính	Giá trị
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

Thuộc tính

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
trade_no	string	true	không có	none
pm_id	integer	true	không có	none
pay_method	integer	true	không có	none
trade_type	string	true	không có	none
country_code	string	true	không có	none
currency	string	true	không có	none
goods_fee	number	true	không có	none
discount_fee	number	true	không có	none
handling_fee	number	true	không có	none
pay_fee	number	true	không có	none
total_fee	number	true	không có	none
pay_method_info	any	true	không có	none

oneOf

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	object	false	không có	none
»» id	integer	true	không có	none
»» type	integer	true	không có	none
»» title	string	true	không có	none
»» group	string	true	không có	none
»» handling_rate	number	true	không có	none
»» handling_fee	number	true	không có	none
»» handling_fee_currency	string	true	không có	none
»» handling_fee_converted	number	true	không có	none

xor

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
» anonymous	null	false	không có	none

continued

Tên	Kiểu	Bắt buộc	Giới hạn	Mô tả
origin	object	true	không có	none
» pm_id	integer	true	không có	none
» pay_method	integer	true	không có	none
» goods_fee	number	true	không có	none
» discount_fee	number	true	không có	none
» handling_fee	number	true	không có	none
» pay_fee	number	true	không có	none
» total_fee	number	true	không có	none