ProxyLite OpenAPI
Ключ аутентификации app_key можно посмотреть на главной странице личного кабинета после входа в систему.
Пожалуйста, храните ключ в безопасности, так как он предоставляет права администратора вашей учетной записи.
Base URLs:
https://api.proxylite.com
Способы аутентификации
Аутентификация App Key
POST параметр:
app_key: {your_app_key}
Или как параметр запроса:
?app_key={your_app_key}
Формат ответа
Все интерфейсы возвращают единый формат JSON:
{
"code": 200,
"message": "операция успешна",
"data": {}
}
code: Код состояния, 200 означает успех, другие значения означают ошибкуmessage: Сообщение ответа (на русском)data: Данные ответа
Authentication
Данный интерфейс поддерживает следующие два способа аутентификации:
1. Bearer Token (JWT)
Передача токена через HTTP Header.
Пример Header:
Authorization: Bearer <your_jwt_token>
Аутентификация API Key
Данный интерфейс использует метод аутентификации API Key.
Клиент должен передавать параметр app_key в запросе, иначе запрос будет отклонен.
Пример:
GET /api/example?app_key=your_app_key
POST /api/example?app_key=your_app_key
Content-Type: application/json
Управление прокси-аккаунтами
GET Список прокси-аккаунтов
GET /end-point/whitelist-account/list
Пример ответа
Успешный ответ (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
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | responseCode | false | none | Код состояния, 200 успех, 3 app_key недействителен | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» id | integer | false | none | Номер аккаунта | |
| »»» username | string | false | none | Имя прокси-аккаунта | |
| »»» password | string | false | none | Пароль прокси-аккаунта | |
| »»» created_at | string | false | none | Время добавления | |
| »»» remark | string | false | none | Примечание | |
| »»» product_type | productTypes | false | none | Тип тарифа: 9 динамический жилой трафик, 11 динамический жилой IP, 14 статический IP дата-центра, 25 статический жилой IP | |
| »»» usage_flow | integer | false | none | Использованный трафик, единица: KB | |
| »»» limit_flow | integer | false | none | Пользовательский лимит трафика: единица GB максимум 102400, 0 без ограничений | |
| »»» status | integer | false | none | Статус активации: 1 активен, 0 отключен |
Значения перечисления
| Атрибут | Значение |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
POST Добавить прокси-аккаунт
POST /end-point/whitelist-account/add
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01:pass,user02:pass,user03:pass",
"remark": "",
"product_type": 9
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » accounts | body | string | Нет | Аккаунт и пароль, заполните в формате username:password, аккаунт и пароль поддерживают только цифры и буквы, запрещено вводить любые специальные символы или пробелы, двоеточие разделяет аккаунт и пароль. Поддерживается массовое добавление, разделяйте прокси-аккаунты английской запятой (,). |
| » remark | body | string | Нет | Описание прокси-аккаунта |
| » product_type | body | productTypes | Нет | Тип тарифа: 9 динамический жилой трафик, 11 динамический жилой IP, 14 статический IP дата-центра, 25 статический жилой IP |
Значения перечисления
| Атрибут | Значение |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния, 200 успех, 3 app_key недействителен, 156 аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST Удалить прокси-аккаунт
POST /end-point/whitelist-account/delete
Обратите внимание, что после удаления восстановление невозможно, использованный трафик и другие данные не могут быть запрошены. Удаление занимает около 5 минут ожидания, в течение этого периода могут продолжать начисляться расходы.
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » accounts | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. Поддерживается массовая операция, разделяйте прокси-аккаунты английской запятой (,) |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния, 200 успех, 3 app_key недействителен, 156 аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST Отключить прокси-аккаунт
POST /end-point/whitelist-account/disable
Отключение занимает около 5 минут ожидания, в течение этого периода могут продолжать начисляться расходы.
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » accounts | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. Поддерживается массовая операция, разделяйте прокси-аккаунты английской запятой (,) |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST 启用Прокси-аккаунт
POST /end-point/whitelist-account/enable
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » accounts | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. Поддерживается массовая операция, разделяйте прокси-аккаунты английской запятой (,) |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST Изменить пароль прокси-аккаунта
POST /end-point/whitelist-account/change-password
Обратите внимание, что после изменения требуется около 5 минут ожидания, в течение этого периода старый пароль может продолжать работать.
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"password": "pass"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » account | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. |
| » password | body | string | Нет | Новый пароль прокси-аккаунта, поддерживаются только цифры и буквы. |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST Изменить примечание прокси-аккаунта
POST /end-point/whitelist-account/change-remark
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"remark": ""
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » account | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. |
| » remark | body | string | Нет | Прокси-аккаунт新Примечание，32 个中文Или 64 个英文以内。 |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
POST Изменить лимит трафика прокси-аккаунта
POST /end-point/whitelist-account/change-limit
Обратите внимание, что статистика трафика может иметь задержку до 5 минут, то есть фактическое потребление трафика может превысить этот лимит.
Body параметры запроса
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"limit": 0
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Нет | none |
| » app_key | body | string | Нет | Ключ авторизации |
| » account | body | string | Нет | Прокси-аккаунт, поддерживаются только цифры и буквы. |
| » limit | body | integer | Нет | Лимит трафика, единица: GB, 0 без ограничений |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | null | false | none | none |
Запросы журналов трафика
GET Суммарный использованный трафик по дням
GET /end-point/user-usage-flow/total
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| app_key | query | string(password) | Да | Ключ аутентификации |
| start_time | query | string(Y-m-d H:i:s) | Нет | 起始Время，可精确到秒。请注意，日志记录有 5 分钟以内延迟。默认 7 天以内。 |
| end_time | query | string(Y-m-d H:i:s) | Нет | 截止Время，可精确到秒。请注意，日志记录有 5 分钟以内延迟。默认当前Время。 |
| username | query | string | Нет | 子账户Название,默认查询所有账户，可指定子账户。请注意如果您添加了相同Название的子账户，此查询将返回同名Прокси-аккаунт的所有使用记录。 |
| product_type | query | number | Нет | Тип тарифа |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"day": "2022-08-01",
"flow": 0
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» day | string | false | none | Дата | |
| »»» flow | integer | false | none | Потребленный трафик, единица KB |
Запросы тарифов
GET Список приобретенных тарифов
GET /end-point/user-product/list
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| app_key | query | string(password) | Да | Ключ аутентификации |
| trade_no | query | string | Нет | Номер заказа，请输入完整Номер заказа。不支持模糊搜索。 |
| page | query | number | Нет | 分页，默认：1 |
| size | query | number | Нет | 分页显示Количество,默认：20 |
| product_type | query | number | Нет | Тип тарифа |
Пример ответа
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": "入门级"
}
}
],
"page": 1,
"page_size": 20,
"total_count": 0,
"total_page": 0
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» id | integer | false | none | 套餐编号 | |
| »»» created_at | string | false | none | 套餐生效Время | |
| »»» expired_at | string | false | none | 套餐过期Время,过期后流量无法使用。 | |
| »»» product_type | productTypes | false | none | Тип тарифа，9 Динамический жилой трафик、11 Динамический жилой IP、14 Статический IP дата-центра、25 Статический жилой IP | |
| »»» trade_no | string | false | none | 订单交易号 | |
| »»» order | object | false | none | none | |
| »»»» created_at | string | false | none | 订单创建Время | |
| »»»» pay_at | string | false | none | 订单支付Время | |
| »»»» title | string | false | none | 订单描述 | |
| »» page | integer | false | none | 当前分页 | |
| »» page_size | integer | false | none | 分页大小 | |
| »» total_count | integer | false | none | 总记录Количество | |
| »» total_page | integer | false | none | 总分页Количество |
Значения перечисления
| Атрибут | Значение |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
Извлечение IP
GET Извлечь IP
GET /end-point/ip/v3
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| app_key | query | string(password) | Нет | 访问密钥 |
| cc | query | string | Нет | Страна или регион |
| state | query | string | Нет | Провинция или штат |
| city | query | string | Нет | Город |
| format | query | string | Нет | 获取格式 |
| lb | query | string | Нет | 间隔符，仅 text 格式有效 |
| num | query | number | Нет | 提取Количество |
| life | query | number | Нет | 保持周期-分钟 |
| ep | query | string | Нет | 代理网络 |
Пример ответа
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"
]
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [any] | false | none | none |
GET Список городов
GET /end-point/ip/dynamic-citys
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"name_zh_cn": "美国",
"name_en": "United States",
"continent_code": "NA",
"country_code": "US",
"items": [
{
"city": null,
"state": null,
"continent_code": null,
"country_code": null
}
]
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | Список | |
| »»» name_zh_cn | string | false | none | Страна или регионНазвание | |
| »»» name_en | string | false | none | Страна или регионНазвание | |
| »»» continent_code | string | false | none | КонтинентКод | |
| »»» country_code | string | false | none | Страна или регионКод | |
| »»» items | [object] | false | none | Провинция или штат | |
| »»»» city | string | false | none | ГородНазвание | |
| »»»» state | string | false | none | Провинция или штатНазваниеКод | |
| »»»» continent_code | string | false | none | КонтинентКод | |
| »»»» country_code | string | false | none | Страна или регионКод |
GET Поиск городов
GET /end-point/ip/dynamic-citys/search
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| country_code | query | string | Да | Страна или регионКод |
| state | query | string | Да | ШтатИлиПровинцияКод |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": ["string"]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [string] | false | none | Список |
GET Список штатов
GET /end-point/ip/dynamic-states
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"name_zh_cn": "美国",
"name_en": "United States",
"continent_code": "NA",
"country_code": "US",
"items": [
{
"state": null,
"continent_code": null,
"country_code": null
}
]
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | Список | |
| »»» name_zh_cn | string | false | none | Страна или регионНазвание | |
| »»» name_en | string | false | none | Страна или регионНазвание | |
| »»» continent_code | string | false | none | КонтинентКод | |
| »»» country_code | string | false | none | Страна или регионКод | |
| »»» items | [object] | false | none | Провинция или штат | |
| »»»» state | string | false | none | Провинция или штатНазваниеКод | |
| »»»» continent_code | string | false | none | КонтинентКод | |
| »»»» country_code | string | false | none | Страна или регионКод |
GET Поиск штатов/провинций
GET /end-point/ip/dynamic-states/search
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| country_code | query | string | Да | Страна или регионКод |
Пример ответа
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": ["string"]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос успешен | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [string] | false | none | Список |
GET Извлечь список приобретенных статических IP
GET /end-point/ip/get-static-ip
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| country_code | query | string | Нет | Страна или регионКод |
| product_type | query | number | Нет | Тип продукта, 25:Статический жилой IP, 14: 数据中心 IP |
| trade_no | query | string | Нет | 通过Номер заказа筛选 IP |
| page | query | number | Нет | 页码 |
| size | query | number | Нет | 每页Количество |
| status | query | number | Нет | 状态, 1:有效, 2:Недействителен, 3:即将过期, 4:维护中 |
Значения перечисления
| Атрибут | Значение |
|---|---|
| product_type | 14 |
| product_type | 25 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
Пример ответа
200 Response
{}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | none | Inline |
Структура возвращаемых данных
GET Получить количество статических IP в продаваемых регионах
GET /end-point/static-ip-region
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| isp | query | string | Нет | IP类型 |
IP类型说明
| IP类型 | Описание |
|---|---|
| 1 | 家庭住宅静态IP |
| 0 | 数据中心静态IP |
Пример ответа
200 Response
{
"code": 200,
"msg": "Запрос успешен",
"data": {
"list": [
{
"code": "US",
"number": 55
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | none | Inline |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» code | string | false | none | Страна или регионКод | |
| »»» number | integer | false | none | Количество |
Управление заказами
GET Список заказов
GET /end-point/order/list
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| page_no | query | integer | Нет | none |
| page_size | query | integer | Нет | none |
| trade_no | query | string | Нет | 订单编号 |
| status | query | integer | Нет | Статус заказа |
| product_type | query | integer | Нет | Тип продукта |
Подробное описание
status: Статус заказа
| 状态 | Описание |
|---|---|
| 0 | 待支付 |
| 1 | 已支付 |
| 2 | 超时未支付已取消 |
| 3 | 已退款 |
product_type: Тип продукта
| Тип продукта | Описание |
|---|---|
| 3 | Пополнение баланса |
| 9 | Динамический трафик |
| 11 | Глобальный динамический тариф V2 |
| 12 | Долгосрочный IDC трафик |
| 13 | Жилой статический IP трафик |
| 14 | Статический IP дата-центра тариф |
| 15 | Долгосрочный ISP трафик |
| 16 | Статический трафик |
| 17 | Динамический IP количество тариф |
| 18 | web-scraper |
| 19 | Продление статического IP |
| 20 | Квота замены статического IP |
| 21 | Статический трафикv2 |
| 24 | Дополнительный пакет статического трафика |
| 25 | Жилой статический IP тариф |
| 26 | Дополнительный платеж - некоторые платежные каналы требуют ручного ввода суммы пользователем, например: криптовалюта, если произошла недоплата, необходимо связаться с службой поддержки для дополнительной оплаты через этот продукт |
| 27 | Serp |
| 28 | Video |
Значения перечисления
| Атрибут | Значение |
|---|---|
| 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 |
Пример ответа
200 Response
{
"code": 0,
"message": "Операция успешна",
"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
}
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешно | Inline |
Структура возвращаемых данных
POST Создать заказ
POST /end-point/order/create
因套餐种类较多，且每种套餐存在不同的配置，请根据实际情况填写参数。不正当填写参数可能导致订单创建失败。
examples:
续费静态IP
{
"pid": x, // 联系客服获取
"upids": "1,2,3,4,5,6", // 从 /end-point/ip/get-static-ip 获取对应的ID
"pm_id": 1 // 从 /end-point/payment/list 获取
"coupon_sn: "xxx", // 可选 优惠券
}
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
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Да | none |
| » pid | body | integer | Да | 套餐ID |
| » upids | body | string | Нет | 续费套餐IDСписок |
| » amount | body | number | Нет | 新购套餐Количество |
| » pm_id | body | integer | Да | 支付方式ID |
| » region_list | body | string | Нет | 购买静态IP时指定区域+Количество |
| » coupon_sn | body | string | Нет | 优惠券编号 |
| » use_invitation_registration_discount | body | boolean | Нет | Да否使用邀请注册优惠 |
| » renew_duration | body | integer | Нет | 续费时长-静态IP可选 |
| » product_sku_bandwidth_id | body | integer | Нет | 套餐11：带宽套餐ID |
| » product_sku_concurrency_id | body | integer | Нет | 套餐11：并发套餐ID |
| » recharge_amount | body | integer | Нет | 套餐3：Сумма пополнения |
Пример ответа
200 Response
{
"code": 0,
"message": "Операция успешна",
"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"
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | 创建Успешно | Inline |
Структура возвращаемых данных
POST Отменить заказ
POST /end-point/order/close
Body параметры запроса
{
"trade_no": "string"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | Да | none |
| » trade_no | body | string | Да | none |
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Операция успешна | None |
Управление пользователями
GET Получить информацию о пользователе - временно недоступно
GET /end-point/user/info
Пример ответа
200 Response
{
"code": 0,
"message": "Операция успешна",
"data": {
"id": 0,
"email": "[email protected]",
"phone": "string",
"balance": 0.1,
"status": 0,
"is_real_name": true,
"created_at": "2019-08-24T14:15:22Z"
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешно | Inline |
Структура возвращаемых данных
Управление платежами
GET Получить список способов оплаты
GET /end-point/payment/groups
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| trade_no | query | string | Нет | Номер заказа - 部分订单需要获取特定支付方式时可传入 |
Пример ответа
200 Response
{
"code": 0,
"message": "Операция успешна",
"data": {
"list": [
{
"name": "支付方式分组",
"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
}
]
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | 获取Успешно | Inline |
Структура возвращаемых данных
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| »» name | string | false | none | 分组Название | |
| »» logos | string[] | false | none | 分组图标Список | |
| »» items | object[] | false | none | 分组内项目Список | |
| »»» id | integer | false | none | 支付方式 ID | |
| »»» title | string | false | none | 支付方式Название | |
| »»» logo | string | false | none | 支付方式 Logo | |
| »»» group | string | false | none | 支付方式分组标识 | |
| »»» disabled | boolean | false | none | Да否禁用（默认 false） | |
| »»» min | number | false | none | 最小金额 | |
| »»» max | number | false | none | 最大金额 |
Маркетинг
GET Коэффициент бонуса при пополнении
GET /end-point/activity/balance-recharge-gift-ratio
Коэффициент бонуса при пополнении
Пример ответа
200 Response
{
"code": 0,
"msg": "Операция успешна",
"data": {
"list": [
{
"amount": 100,
"ratio": 1.2
}
]
}
}
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | OK | Inline |
Структура возвращаемых данных
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| » code | integer | false | none | Код состояния,200 Успешно、3 app_key Недействителен、156 Аккаунт не прошел верификацию | |
| » msg | string | false | none | Сообщение о состоянии | |
| » data | object | false | none | none | |
| » list | [object] | false | none | none | |
| »» amount | integer | false | none | Сумма пополнения | |
| »» ratio | number | false | none | Коэффициент пополнения |
Описание структур данных (Schemas)
productTypes（Тип тарифа）
| Поле | Тип | Описание |
|---|---|---|
| product_type | integer | Тип тарифа |
Описание возможных значений:
| Значение | Значение |
|---|---|
| 9 | Динамический жилой трафик |
| 11 | Динамический жилой IP |
| 14 | Статический IP дата-центра |
| 25 | Статический жилой IP |
API Key（Ключ аутентификации）
Используется для аутентификации интерфейса, передается через параметр Query.
| Название параметра | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| app_key | query | string | Да | Ключ аутентификации |
Общие поля ответа
responseCode
| Поле | Тип | Пример | Описание |
|---|---|---|---|
| code | integer | 200 | Код состояния（200 Успешно，3 означает app_key Недействителен） |
responseMsg
| Поле | Тип | Пример | Описание |
|---|---|---|---|
| message | string | success | Информация ответа |
Успешный ответ（SuccessResponse）
{
"code": 0,
"message": "Операция успешна",
"data": {}
}
Ошибочный ответ（ErrorResponse）
{
"code": 400,
"message": "Ошибка параметров",
"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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| 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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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"
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| 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
}
| Название | Тип | Обязательно | Ограничение | Русское название | Описание |
|---|---|---|---|---|---|
| total | integer | false | none | none | |
| page_no | integer | false | none | none | |
| page_size | integer | false | none | none | |
| total_pages | integer | false | none | none |