911Proxy OpenAPI
app_key ключ аутентификации можно посмотреть на главной странице личного кабинета после входа в систему.
Пожалуйста, храните ключ в безопасности, так как он имеет права администратора вашей учетной записи.
Base URLs:
https://api.911proxy.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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 |
GET Сводка пользовательских пакетов
GET /api-gate-way/user-product/summary
Получение статистической сводной информации о пользовательских пакетах, включая общий объём, действующий объём, объём с истекающим сроком действия, просроченный объём и т.д.
Параметры запроса
| Имя параметра | Тип | Обязательно | Описание |
|---|---|---|---|
| app_key | string(password) | Да | Ключ аутентификации |
| product_type | integer | Нет | Тип продукта, поддерживается только: 9 (Динамический пакет трафика), 12 (Долгосрочный IDC пакет трафика) |
返回结果
{
"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
}
}
Структура данных ответа
Код состояния 200
| Поле | Тип | Описание |
|---|---|---|
| total | integer | Общий объём трафика/IP (единица: KB) |
| total_count | integer | Общее количество пакетов |
| effective | integer | Оставшийся действующий объём (единица: KB) |
| effective_count | integer | Количество действующих пакетов |
| effective_total | integer | Общий действующий объём (единица: KB) |
| effective_used | integer | Использованный объём в действующих пакетах (единица: KB) |
| temporary | integer | Общий объём с истекающим сроком (истекает в течение 7 дней, KB) |
| temporary_count | integer | Количество пакетов с истекающим сроком (в течение 7 дней) |
| expired | integer | Оставшийся просроченный объём (единица: KB) |
| expired_count | integer | Количество просроченных пакетов |
| used | integer | Общий использованный объём (единица: KB) |
Извлечение IP
GET Извлечь IP
GET /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/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 /api-gate-way/order/create
Поскольку типов тарифов много, и каждый тариф имеет разные конфигурации, пожалуйста, заполняйте параметры в соответствии с фактической ситуацией. Неправильное заполнение параметров может привести к сбою создания заказа.
examples:
Продление статического IP
{
"pid": x, // Свяжитесь с поддержкой для получения
"upids": "1,2,3,4,5,6", // Получите соответствующий ID из /api-gate-way/ip/get-static-ip
"pm_id": 1 // Получите из /api-gate-way/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 /api-gate-way/order/close
Body параметры запроса
{
"trade_no": "string"
}
Параметры запроса
| Название | Расположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| body | body | object | да | none |
| » trade_no | body | string | да | none |
Результат ответа
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Операция выполнена успешно | None |
Управление пользователями
GET Получить информацию о пользователе - пока не открыто
GET /api-gate-way/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 /api-gate-way/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 | Логотип способа оплаты | |
| »»» group | string | false | none | Идентификатор группы способа оплаты | |
| »»» disabled | boolean | false | none | Отключен ли (по умолчанию false) | |
| »»» min | number | false | none | Минимальная сумма | |
| »»» max | number | false | none | Максимальная сумма |
Маркетинг
GET Коэффициент бонуса при пополнении
GET /api-gate-way/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 |