911Proxy OpenAPI

Vui lòng đăng nhập và xem app_key (khóa xác thực) tại trang chủ trung tâm cá nhân.

Vui lòng lưu trữ khóa an toàn, khóa có quyền quản trị viên tài khoản của bạn.

Base URLs:

https://api.911proxy.com

Phương thức xác thực

Xác thực App Key

Tham số POST:

app_key: {your_app_key}

Hoặc làm tham số truy vấn:

?app_key={your_app_key}

Định dạng phản hồi

Tất cả các giao diện trả về định dạng JSON thống nhất:

{
	"code": 200,
	"message": "Thao tác thành công",
	"data": {}
}

code: Mã trạng thái, 200 biểu thị thành công, các giá trị khác biểu thị thất bại
message: Thông báo phản hồi (tiếng Trung)
data: Dữ liệu phản hồi

Authentication

Giao diện này hỗ trợ hai phương thức xác thực sau:

1. Bearer Token（JWT）

Truyền Token qua HTTP Header.

Ví dụ Header:

Authorization: Bearer <your_jwt_token>

Xác thực API Key

Giao diện này sử dụng phương thức API Key để xác thực danh tính.

Client cần mang tham số app_key trong yêu cầu, nếu không yêu cầu sẽ bị từ chối.

Ví dụ:

GET /api/example?app_key=your_app_key

POST /api/example?app_key=your_app_key
Content-Type: application/json

Quản lý tài khoản proxy

GET Danh sách tài khoản proxy

GET /api-gate-way/whitelist-account/list

Ví dụ trả về

Phản hồi thành công（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
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	responseCode	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Mã tài khoản
»»» username	string	false	none	Tên tài khoản proxy
»»» password	string	false	none	Mật khẩu tài khoản proxy
»»» created_at	string	false	none	Thời gian thêm
»»» remark	string	false	none	Ghi chú
»»» product_type	productTypes	false	none	Loại gói, 9 Gói lưu lượ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	none	Lưu lượng đã sử dụng, đơn vị: KB
»»» limit_flow	integer	false	none	Giới hạn lưu lượng tùy chỉnh: đơn vị GB tối đa 102400, 0 không giới hạn
»»» status	integer	false	none	Trạng thái kích hoạt: 1 kích hoạt, 0 vô hiệu hóa

Giá trị liệt kê

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

POST Thêm tài khoản proxy

POST /api-gate-way/whitelist-account/add

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» accounts	body	string	Không	Tài khoản mật khẩu, vui lòng điền theo định dạng username:password, 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ý tự đặc biệt hoặc khoảng trắng nào, dấu hai chấm phân tách tài khoản và mật khẩu. Hỗ trợ thêm hàng loạt, dấu phẩy tiếng Anh (,) phân tách các tài khoản proxy.
» remark	body	string	Không	Mô tả tài khoản proxy
» product_type	body	productTypes	Không	Loại gói, 9 Gói lưu lượ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ị
» product_type	9
» product_type	11
» product_type	14
» product_type	25

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Xóa tài khoản proxy

POST /api-gate-way/whitelist-account/delete

Vui lòng lưu ý sau khi xóa không thể khôi phục, lưu lượng đã sử dụng v.v. không thể truy vấn. Xóa có khoảng 5 phút thời gian chờ, trong thời gian này vẫn có thể phát sinh phí.

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» accounts	body	string	Không	Tài khoản proxy, 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 các tài khoản proxy

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Vô hiệu hóa tài khoản proxy

POST /api-gate-way/whitelist-account/disable

Vô hiệu hóa có khoảng 5 phút thời gian chờ, trong thời gian này vẫn có thể phát sinh phí.

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» accounts	body	string	Không	Tài khoản proxy, 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 các tài khoản proxy

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Kích hoạt tài khoản proxy

POST /api-gate-way/whitelist-account/enable

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» accounts	body	string	Không	Tài khoản proxy, 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 các tài khoản proxy

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Thay đổi mật khẩu tài khoản proxy

POST /api-gate-way/whitelist-account/change-password

Vui lòng lưu ý sau khi thay đổi có 5 phút thời gian chờ, trong thời gian này mật khẩu cũ vẫn có thể sử dụng bình thường.

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» account	body	string	Không	Tài khoản proxy, chỉ hỗ trợ số và chữ cái.
» password	body	string	Không	Mật khẩu mới của tài khoản proxy, chỉ hỗ trợ số và chữ cái.

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Thay đổi ghi chú tài khoản proxy

POST /api-gate-way/whitelist-account/change-remark

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» account	body	string	Không	Tài khoản proxy, chỉ hỗ trợ số và chữ cái.
» remark	body	string	Không	Ghi chú mới của tài khoản proxy, trong vòng 32 ký tự tiếng Trung hoặc 64 ký tự tiếng Anh.

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

POST Thay đổi giới hạn lưu lượng tài khoản proxy

POST /api-gate-way/whitelist-account/change-limit

Vui lòng lưu ý thống kê lưu lượng có thể có độ trễ trong vòng 5 phút, tức là lưu lượng tiêu thụ thực tế có thể vượt quá giới hạn này.

Tham số yêu cầu Body

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

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Không	none
» app_key	body	string	Không	Khóa ủy quyền
» account	body	string	Không	Tài khoản proxy, chỉ hỗ trợ số và chữ cái.
» limit	body	integer	Không	Giới hạn lưu lượng, đơn vị: GB, 0 là không đặt giới hạn

Ví dụ trả về

200 Response

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

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	null	false	none	none

Truy vấn nhật ký lưu lượng

GET Tổng hợp lưu lượng sử dụng theo ngày

GET /api-gate-way/user-usage-flow/total

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
app_key	query	string(password)	Có	Khóa xác thực
start_time	query	string(Y-m-d H:i:s)	Không	Thời gian bắt đầu, có thể chính xác đến giây. Vui lòng lưu ý, ghi nhật ký có độ trễ trong vòng 5 phút. Mặc định trong vòng 7 ngày.
end_time	query	string(Y-m-d H:i:s)	Không	Thời gian kết thúc, có thể chính xác đến giây. Vui lòng lưu ý, ghi nhật ký có độ trễ trong vòng 5 phút. Mặc định là thời gian hiện tại.
username	query	string	Không	Tên tài khoản phụ, mặc định truy vấn tất cả tài khoản, có thể chỉ định tài khoản phụ. Vui lòng lưu ý nếu bạn đã thêm tài khoản phụ cùng tên, truy vấn này sẽ trả về tất cả các bản ghi sử dụng của tài khoản proxy cùng tên.
product_type	query	number	Không	Loại gói

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	Ngày
»»» flow	integer	false	none	Lưu lượng tiêu thụ, đơn vị KB

Truy vấn gói

GET Danh sách gói đã mua

GET /api-gate-way/user-product/list

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
app_key	query	string(password)	Có	Khóa xác thực
trade_no	query	string	Không	Số đơn hàng, vui lòng nhập số đơn hàng đầy đủ. Không hỗ trợ tìm kiếm mờ.
page	query	number	Không	Phân trang, mặc định: 1
size	query	number	Không	Số lượng hiển thị phân trang, mặc định: 20
product_type	query	number	Không	Loại gói

Ví dụ trả về

200 Response

{
	"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": "Cấp nhập môn"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	Mã gói
»»» created_at	string	false	none	Thời gian gói có hiệu lực
»»» expired_at	string	false	none	Thời gian gói hết hạn, sau khi hết hạn lưu lượng không thể sử dụng.
»»» product_type	productTypes	false	none	Loại gói, 9 Gói lưu lượ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	none	Số giao dịch đơn hàng
»»» order	object	false	none	none
»»»» created_at	string	false	none	Thời gian tạo đơn hàng
»»»» pay_at	string	false	none	Thời gian thanh toán đơn hàng
»»»» title	string	false	none	Mô tả đơn hàng
»» page	integer	false	none	Trang hiện tại
»» page_size	integer	false	none	Kích thước trang
»» total_count	integer	false	none	Tổng số bản ghi
»» total_page	integer	false	none	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

GET Tóm tắt Gói Người dùng

GET /api-gate-way/user-product/summary

Lấy thông tin tóm tắt thống kê về các gói của người dùng, bao gồm tổng dung lượng, dung lượng còn hiệu lực, dung lượng sắp hết hạn, dung lượng đã hết hạn, v.v.

Tham số yêu cầu

Tên tham số	Kiểu	Bắt buộc	Mô tả
app_key	string(password)	Có	Khóa xác thực
product_type	integer	Không	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)

Phản hồi

{
	"code": 200,
	"msg": "Thành công",
	"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
	}
}

Cấu trúc dữ liệu phản hồi

Mã trạng thái 200

Trường	Kiểu	Mô tả
total	integer	Tổng dung lượng lưu lượng/IP (đơn vị: KB)
total_count	integer	Tổng số gói
effective	integer	Dung lượng còn hiệu lực (đơn vị: KB)
effective_count	integer	Số gói còn hiệu lực
effective_total	integer	Tổng dung lượng còn hiệu lực (đơn vị: KB)
effective_used	integer	Dung lượng đã sử dụng trong các gói còn hiệu lực (đơn vị: KB)
temporary	integer	Tổng dung lượng sắp hết hạn (hết hạn trong vòng 7 ngày, KB)
temporary_count	integer	Số gói sắp hết hạn (trong vòng 7 ngày)
expired	integer	Dung lượng còn lại đã hết hạn (đơn vị: KB)
expired_count	integer	Số gói đã hết hạn
used	integer	Tổng dung lượng đã sử dụng (đơn vị: KB)

Trích xuất IP

GET Trích xuất IP

GET /api-gate-way/ip/v3

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
app_key	query	string(password)	Không	Khóa truy cập
cc	query	string	Không	Quốc gia hoặc khu vực
state	query	string	Không	Tỉnh hoặc bang
city	query	string	Không	Thành phố
format	query	string	Không	Định dạng lấy
lb	query	string	Không	Ký tự phân cách, chỉ có hiệu lực với định dạng text
num	query	number	Không	Số lượng trích xuất
life	query	number	Không	Chu kỳ duy trì - phút
ep	query	string	Không	Mạng proxy

Ví dụ trả về

200 Response

{
	"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"
			]
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[any]	false	none	none

GET Danh sách thành phố

GET /api-gate-way/ip/dynamic-citys

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "Hoa Kỳ",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	Danh sách
»»» name_zh_cn	string	false	none	Tên quốc gia hoặc khu vực
»»» name_en	string	false	none	Tên quốc gia hoặc khu vực
»»» continent_code	string	false	none	Mã châu lục
»»» country_code	string	false	none	Mã quốc gia hoặc khu vực
»»» items	[object]	false	none	Tỉnh hoặc bang
»»»» city	string	false	none	Tên thành phố
»»»» state	string	false	none	Mã tên tỉnh hoặc bang
»»»» continent_code	string	false	none	Mã châu lục
»»»» country_code	string	false	none	Mã quốc gia hoặc khu vực

GET Tìm kiếm thành phố

GET /api-gate-way/ip/dynamic-citys/search

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
country_code	query	string	Có	Mã quốc gia hoặc khu vực
state	query	string	Có	Mã bang hoặc tỉnh

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[string]	false	none	Danh sách

GET Danh sách bang

GET /api-gate-way/ip/dynamic-states

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "Hoa Kỳ",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	Danh sách
»»» name_zh_cn	string	false	none	Tên quốc gia hoặc khu vực
»»» name_en	string	false	none	Tên quốc gia hoặc khu vực
»»» continent_code	string	false	none	Mã châu lục
»»» country_code	string	false	none	Mã quốc gia hoặc khu vực
»»» items	[object]	false	none	Tỉnh hoặc bang
»»»» state	string	false	none	Mã tên tỉnh hoặc bang
»»»» continent_code	string	false	none	Mã châu lục
»»»» country_code	string	false	none	Mã quốc gia hoặc khu vực

GET Tìm kiếm bang/tỉnh

GET /api-gate-way/ip/dynamic-states/search

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
country_code	query	string	Có	Mã quốc gia hoặc khu vực

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Yêu cầu thành công	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[string]	false	none	Danh sách

GET Trích xuất danh sách IP tĩnh đã mua

GET /api-gate-way/ip/get-static-ip

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
country_code	query	string	Không	Mã quốc gia hoặc khu vực
product_type	query	number	Không	Loại sản phẩm, 25: IP dân cư tĩnh, 14: IP trung tâm dữ liệu
trade_no	query	string	Không	Lọc IP theo số đơn hàng
page	query	number	Không	Số trang
size	query	number	Không	Số lượng mỗi trang
status	query	number	Không	Trạng thái, 1: có hiệu lực, 2: không hiệu lực, 3: sắp hết hạn, 4: đang bảo trì

Giá trị liệt kê

Thuộc tính	Giá trị
product_type	14
product_type	25
status	1
status	2
status	3
status	4

Ví dụ trả về

200 Response

{}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	none	Inline

Cấu trúc dữ liệu trả về

GET Lấy số lượng IP tĩnh khu vực đang bán

GET /api-gate-way/static-ip-region

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
isp	query	string	Không	Loại IP

Mô tả loại IP

Loại IP	Mô tả
1	IP tĩnh dân cư gia đình
0	IP tĩnh trung tâm dữ liệu

Ví dụ trả về

200 Response

{
	"code": 200,
	"msg": "Yêu cầu thành công",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	none	Inline

Cấu trúc dữ liệu trả về

Mã trạng thái 200

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	false	none	Mã quốc gia hoặc khu vực
»»» number	integer	false	none	Số lượng

Quản lý đơn hàng

GET Danh sách đơn hàng

GET /api-gate-way/order/list

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
page_no	query	integer	Không	none
page_size	query	integer	Không	none
trade_no	query	string	Không	Mã đơn hàng
status	query	integer	Không	Trạng thái đơn hàng
product_type	query	integer	Không	Loại sản phẩm

Mô tả chi tiết

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

Trạng thái	Mô tả
0	Chờ thanh toán
1	Đã thanh toán
2	Quá hạn chưa thanh toán đã hủy
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 theo thời gian toàn cầu độ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 cư
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	web-scraper
19	Gia hạn IP tĩnh
20	Hạn mức thay đổi IP tĩnh
21	Gói lưu lượng tĩnh v2
24	Gói bổ sung lưu lượng tĩnh
25	Gói IP tĩnh dân cư
26	Bổ sung đơn - Một số kênh thanh toán yêu cầu người dùng điền số tiền thủ công, ví dụ: tiền ảo, nếu xảy ra thiếu tiền, cần liên hệ dịch vụ khách hàng để thanh toán bổ sung qua loại sản phẩm này
27	Serp
28	Video

Giá trị liệt kê

Thuộc tính	Giá trị
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

Ví dụ trả về

200 Response

{
	"code": 0,
	"message": "Thao tác thành công",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Thành công	Inline

{
    "pid": x, // Liên hệ dịch vụ khách hàng để lấy
    "upids": "1,2,3,4,5,6", // Lấy ID tương ứng từ /api-gate-way/ip/get-static-ip
    "pm_id": 1 // Lấy từ /api-gate-way/payment/list
    "coupon_sn: "xxx", // Tùy chọn - Mã giảm giá
  }

Tham số yêu cầu Body

{
	"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,
	"recharge_amount": 0
}

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Có	none
» pid	body	integer	Có	ID gói
» upids	body	string	Không	Danh sách ID gói gia hạn
» amount	body	number	Không	Số lượng gói mua mới
» pm_id	body	integer	Có	ID phương thức thanh toán
» region_list	body	string	Không	Chỉ định khu vực + số lượng khi mua IP tĩnh
» coupon_sn	body	string	Không	Mã phiếu giảm giá
» use_invitation_registration_discount	body	boolean	Không	Có sử dụng ưu đãi đăng ký mời không
» renew_duration	body	integer	Không	Thời hạn gia hạn - IP tĩnh tùy chọn
» product_sku_bandwidth_id	body	integer	Không	Gói 11: ID gói băng thông
» product_sku_concurrency_id	body	integer	Không	Gói 11: ID gói đồng thời
» recharge_amount	body	integer	Không	Gói 3: Số tiền nạp

Ví dụ trả về

200 Response

{
	"code": 0,
	"message": "Thao tác thành công",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Tạo thành công	Inline

Cấu trúc dữ liệu trả về

POST Hủy đơn hàng

POST /api-gate-way/order/close

Tham số yêu cầu Body

{
	"trade_no": "string"
}

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
body	body	object	Có	none
» trade_no	body	string	Có	none

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Thao tác thành công	None

Quản lý người dùng

GET Lấy thông tin người dùng - Chưa mở

GET /api-gate-way/user/info

Ví dụ trả về

200 Response

{
	"code": 0,
	"message": "Thao tác thành công",
	"data": {
		"id": 0,
		"email": "[email protected]",
		"phone": "string",
		"balance": 0.1,
		"status": 0,
		"is_real_name": true,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Thành công	Inline

Cấu trúc dữ liệu trả về

Quản lý thanh toán

GET Lấy danh sách phương thức thanh toán

GET /api-gate-way/payment/groups

Tham số yêu cầu

Tên	Vị trí	Loại	Bắt buộc	Mô tả
trade_no	query	string	Không	Số đơn hàng - Có thể truyền khi cần lấy phương thức thanh toán cụ thể cho một số đơn hàng

Ví dụ trả về

200 Response

{
	"code": 0,
	"message": "Thao tác thành công",
	"data": {
		"list": [
			{
				"name": "Nhóm phương thức thanh toán",
				"logos": ["https://example.com/logo1.png", "https://example.com/logo2.png"],
				"items": [
					{
						"id": 1,
						"title": "title1",
						"logo": "https://example.com/logo1.png",
						"group": "online",
						"disabled": false,
						"min": 10,
						"max": 5000
					}
				]
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	Lấy thành công	Inline

Cấu trúc dữ liệu trả về

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
»» name	string	false	none	Tên nhóm
»» logos	string[]	false	none	Danh sách biểu tượng nhóm
»» items	object[]	false	none	Danh sách mục trong nhóm
»»» id	integer	false	none	ID phương thức thanh toán
»»» title	string	false	none	Tên phương thức thanh toán
»»» logo	string	false	none	Logo phương thức thanh toán
»»» group	string	false	none	Mã nhận dạng nhóm phương thức thanh toán
»»» disabled	boolean	false	none	Có bị vô hiệu hóa không (mặc định `false`)
»»» min	number	false	none	Số tiền tối thiểu
»»» max	number	false	none	Số tiền tối đa

Marketing

GET Tỷ lệ tặng tiền nạp

GET /api-gate-way/activity/balance-recharge-gift-ratio

Tỷ lệ tặng tiền nạp

Ví dụ trả về

200 Response

{
	"code": 0,
	"msg": "Thao tác thành công",
	"data": {
		"list": [
			{
				"amount": 100,
				"ratio": 1.2
			}
		]
	}
}

Kết quả trả về

Mã trạng thái	Ý nghĩa mã trạng thái	Mô tả	Mô hình dữ liệu
200	OK	OK	Inline

Cấu trúc dữ liệu trả về

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
» code	integer	false	none	Mã trạng thái, 200 thành công, 3 app_key không hợp lệ, 156 tài khoản chưa xác thực danh tính
» msg	string	false	none	Thông báo trạng thái
» data	object	false	none	none
» list	[object]	false	none	none
»» amount	integer	false	none	Số tiền nạp
»» ratio	number	false	none	Tỷ lệ nạp

Mô tả cấu trúc dữ liệu (Schemas)

productTypes (Loại gói)

Trường	Loại	Mô tả
product_type	integer	Loại gói

Mô tả giá trị tùy chọn:

Giá trị	Ý nghĩa
9	Gói lưu lượ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

API Key (Khóa xác thực)

Dùng để xác thực danh tính giao diện, vui lòng truyền qua tham số Query.

Tên tham số	Vị trí	Loại	Bắt buộc	Mô tả
app_key	query	string	Có	Khóa xác thực

Trường phản hồi chung

responseCode

Trường	Loại	Ví dụ	Mô tả
code	integer	200	Mã trạng thái (200 thành công, 3 biểu thị app_key không hợp lệ)

responseMsg

Trường	Loại	Ví dụ	Mô tả
message	string	success	Thông tin phản hồi

Phản hồi thành công (SuccessResponse)

{
	"code": 0,
	"message": "Thao tác thành công",
	"data": {}
}

Phản hồi lỗi (ErrorResponse)

{
	"code": 400,
	"message": "Lỗi tham số",
	"errors": {}
}

User

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	none

Order

{
	"id": 0,
	"trade_no": "string",
	"product_id": 0,
	"product_name": "string",
	"total_fee": 0.1,
	"pay_fee": 0.1,
	"status": 0,
	"created_at": "2019-08-24T14:15:22Z"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
trade_no	string	false	none	none
product_id	integer	false	none	none
product_name	string	false	none	none
total_fee	number(float)	false	none	none
pay_fee	number(float)	false	none	none
status	integer	false	none	none
created_at	string(date-time)	false	none	none

Product

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
name	string	false	none	none
type	integer	false	none	none
price	number(float)	false	none	none
description	string	false	none	none

WhiteIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}

Tên	Loại	Bắt buộc	Ràng buộc	Mô tả
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	none