OpenAPIOpenAPI
  • English
  • 简体中文
  • Indonesia
  • हिंदी
  • Русский
  • Tiếng Việt
  • German
  • português
  • English
  • 简体中文
  • Indonesia
  • हिंदी
  • Русский
  • Tiếng Việt
  • German
  • português
  • ProxyCC OpenAPI

ProxyCC OpenAPI

Пожалуйста, войдите в систему, чтобы просмотреть ключ аутентификации app_key на главной странице вашего личного кабинета.

Пожалуйста, храните ключ в безопасности, так как он имеет права администратора для вашей учетной записи.

Базовые URL-адреса:

https://api.proxy.cc

Метод аутентификации

Аутентификация по App Key

POST-параметры:

app_key: {your_app_key}

Или как параметр запроса:

?app_key={your_app_key}

Формат ответа

Все интерфейсы возвращают унифицированный формат JSON:

{
	"code": 200,
	"message": "操作成功",
	"data": {}
}
  • code: Код состояния, 200 означает успех, другие значения указывают на неудачу
  • message: Ответное сообщение (китайский)
  • data: Данные ответа

Аутентификация

Этот интерфейс поддерживает следующие два метода аутентификации:

1. Bearer Token (JWT)

Передача токена через HTTP-заголовок.

Пример заголовка:

Authorization: Bearer <your_jwt_token>

Аутентификация по API-ключу

Этот интерфейс использует метод аутентификации на основе API-ключа.

Клиент должен включить параметр app_key в запрос, иначе запрос будет отклонен.

Пример:

GET /api/example?app_key=your_app_key

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

Управление прокси-аккаунтом

ПОЛУЧИТЬ список прокси-аккаунтов

GET /open/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
			}
		]
	}
}

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKЗапрос выполнен успешноВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодresponseCodeложьотсутствуетКод статуса, 200 – успех, 3 – недействительный app_key
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетотсутствует
»»» idцелое числоложьотсутствуетНомер счёта
»»» имя пользователястрокаложьотсутствуетИмя учётной записи агента
»»» парольстрокаложьотсутствуетПароль учетной записи агента
»»» created_atстрокаложьотсутствуетВремя добавления
»»» замечаниестрокаложьотсутствуетПримечания
»»» тип_продуктаТипы продуктовложьотсутствуетТип пакета, 9 Динамический пакет трафика для жилых IP, 11 Динамический жилой IP, 14 Статический IP для дата-центров, 25 Статический жилой IP
»»» usage_flowцелое числоложьотсутствуетИспользованный трафик, единица измерения: КБ
»»» ограничение_потокацелое числоложьотсутствуетПользовательский лимит трафика: единица измерения ГБ, максимум 102400, 0 для неограниченного
»»» статусцелое числоложьотсутствуетСтатус включения: 1 включено, 0 выключено

Значение перечисления

СвойствоЗначение
product_type9
product_type11
product_type14
product_type25

POST Добавить прокси-аккаунт

POST /open/whitelist-account/add

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательныйОписание
телотелообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» аккаунтытелострокаНетПароль учетной записи, пожалуйста, заполните в формате имя_пользователя:пароль. Для учетной записи и пароля поддерживаются только цифры и буквы. Не вводите специальные символы или пробелы. Разделите имя пользователя и пароль двоеточием. Поддерживается пакетное добавление, а прокси-аккаунты разделяются английскими запятыми (,).
» remarkтелострокаНетОписание прокси-аккаунта
» Тип_продуктателоproductTypesНетТип пакета, 9 Динамический пакет трафика для жилых сетей, 11 Динамический IP-адрес для жилых сетей, 14 Статический IP-адрес для дата-центров, 25 Статический IP-адрес для жилых сетей

Значение перечисления

СвойствоЗначение
» Тип_продукта9
» Тип_продукта11
» Тип_продукта14
» Тип_продукта25

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKЗапрос выполнен успешноВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательныйОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» datanullложьотсутствуетотсутствует

POST Удалить прокси-аккаунт

POST /open/whitelist-account/delete

Обратите внимание, что удаление необратимо, и использованный трафик и другие данные не могут быть запрошены после удаления. Удаление занимает примерно 5 минут, и в течение этого периода может взиматься плата.

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательныйОписание
Тело запросателообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» аккаунтытело запросастрокаНетПрокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,).

Пример возврата

200 Response

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» datanullложьотсутствуетотсутствует

POST Отключить прокси-аккаунт

POST /open/whitelist-account/disable

Отключение занимает примерно 5 минут, в течение которых может взиматься плата.

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
телотелообъектНетни один
» app_keyтелострокаНетКлюч авторизации
» аккаунтытелострокаНетПрокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,).

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKЗапрос выполнен успешноВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательныйОграничениеКитайское названиеПояснение
» кодцелое числоложьотсутствуетКод состояния: 200 – успех, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о статусе
» datanullложьотсутствуетотсутствует

POST Включить прокси-аккаунт

POST /open/whitelist-account/enable

Параметры запроса в теле

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

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
телотелообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» аккаунтытелострокаНетПрокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,).

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» datanullложьотсутствуетотсутствует

POST Изменить пароль прокси-аккаунта

POST /open/whitelist-account/change-password

Обратите внимание, что после изменения действует 5-минутный период ожидания, в течение которого старый пароль все еще может использоваться в обычном режиме.

Параметры запроса в теле

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

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
телотелообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» учетная записьтелострокаНетПрокси-аккаунт, поддерживает только цифры и буквы.
» парольтелострокаНетНовый пароль для прокси-аккаунта, поддерживаются только цифры и буквы.

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

НазваниеТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» datanullложьотсутствуетотсутствует

POST Изменить примечания к прокси-аккаунту

POST /open/whitelist-account/change-remark

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательныйОписание
телотелообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» учетная записьтелострокаНетПрокси-аккаунт, поддерживает только цифры и буквы.
» remarkтелострокаНетПримечание к новой учетной записи агента, не более 32 китайских иероглифов или 64 английских символов.

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» datanullложьотсутствуетотсутствует

POST Изменить лимит трафика аккаунта агента

POST /open/whitelist-account/change-limit

Обратите внимание, что статистика трафика может задерживаться до 5 минут, а это означает, что фактическое потребление трафика может превышать этот лимит.

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательныйОписание
телотелообъектНетотсутствует
» app_keyтелострокаНетКлюч авторизации
» учетная записьтелострокаНетПрокси-аккаунт, поддерживает только цифры и буквы.
» limitтелоцелое числоНетОграничение трафика, единица измерения: ГБ, 0 означает отсутствие ограничений

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKЗапрос выполнен успешноВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод статуса: 200 Success, 3 invalid app_key, 156 account not real-name authenticated
» msgстрокаложьотсутствуетСообщение о статусе
» datanullложьотсутствуетотсутствует

Запрос журнала трафика

ПОЛУЧИТЬ агрегированный трафик использования по дням

GET /open/user-usage-flow/total

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
app_keyЗапросstring(password)ДаКлюч аутентификации
start_timeЗапросстрока(Г-м-д Ч:м:с)НетВремя начала, с точностью до секунды. Обратите внимание, что в ведении журнала может быть задержка до 5 минут. По умолчанию за 7 дней.
end_timeЗапросстрока(Г-м-д Ч:м:с)НетВремя окончания, с точностью до секунды. Обратите внимание, что в ведении журнала может быть задержка до 5 минут. По умолчанию текущее время.
имя пользователяЗапросстрокаНетИмя суб-аккаунта, по умолчанию запрашиваются все аккаунты, можно указать конкретный суб-аккаунт. Обратите внимание, что если вы добавили суб-аккаунты с одинаковым именем, этот запрос вернет все записи об использовании для прокси-аккаунтов с одинаковым именем.
product_typeЗапросНомерНетТип пакета

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод статуса: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетотсутствует
»»» деньстрокаложьотсутствуетДата
»»» трафикцелое числоложьотсутствуетРасход трафика, единица измерения: КБ

Запрос пакета

ПОЛУЧИТЬ список приобретенных пакетов

GET /open/user-product/list

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
app_keyЗапросstring(password)ДаКлюч аутентификации
trade_noЗапросстрокаНетНомер заказа, пожалуйста, введите полный номер заказа. Нечеткий поиск не поддерживается.
страницаЗапросНомерНетРазбивка на страницы, по умолчанию: 1
sizeЗапросНомерНетКоличество элементов на странице, по умолчанию: 20
product_typeЗапросНомерНетТип пакета

Пример возврата

Ответ 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "入门级"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательныйОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетотсутствует
»»» idцелое числоложьотсутствуетНомер пакета
»»» created_atстрокаложьотсутствуетВремя активации пакета
»»» expired_atстрокаложьотсутствуетВремя истечения срока действия пакета, после истечения срока действия трафик нельзя использовать.
»»» тип_продуктаТипы продуктовложьотсутствуетТип пакета: 9 Динамический пакет трафика для жилых сетей, 11 Динамический IP-адрес для жилых сетей, 14 Статический IP-адрес для дата-центров, 25 Статический IP-адрес для жилых сетей
»»» trade_noстрокаложьотсутствуетНомер транзакции заказа
»»» заказобъектложьотсутствуетотсутствует
»»»» created_atстрокаложьотсутствуетВремя создания заказа
»»»» оплатить_пристрокаложьотсутствуетВремя оплаты заказа
»»»» заголовокстрокаложьотсутствуетОписание заказа
»» страницацелое числоложьотсутствуетТекущая страница
»» page_sizeцелое числоложьотсутствуетРазмер страницы
»» total_countцелое числоложьотсутствуетОбщее количество записей
»» total_pageцелое числоложьотсутствуетОбщее количество страниц

Значение перечисления

СвойствоЗначение
product_type9
product_type11
product_type14
product_type25

Извлечение IP-адреса

GET Извлечь IP-адрес

GET /open/ip/v3

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
app_keyЗапросstring(password)НетКлюч доступа
скЗапросстрокаНетСтрана или регион
состояниеЗапросстрокаНетОбласть или провинция
городЗапросстрокаНетГород
форматЗапросстрокаНетПолучить формат
лбЗапросстрокаНетРазделитель, действителен только для текстового формата
Кол-воЗапросНомерНетКоличество извлечений
жизньЗапросНомерНетСохранять цикл - Минуты
эпЗапросстрокаНетПрокси-сеть

Пример возврата

Ответ 200

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» dataобъектложьотсутствуетотсутствует
»» список[любой]ложьотсутствуетотсутствует

ПОЛУЧИТЬ Список городов

GET /open/ip/dynamic-citys

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательныйОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетСписок
»»» name_zh_cnстрокаложьотсутствуетНазвание страны или региона
»»» name_enстрокаложьотсутствуетНазвание страны или региона
»»» continent_codeстрокаложьотсутствуетКод континента
»»» код_страныстрокаложьотсутствуетКод страны или региона
»»» элементы[объект]ложьотсутствуетШтат или провинция
»»»» городстрокаложьотсутствуетНазвание города
»»»» штатстрокаложьотсутствуетКод провинции или штата
»»»» continent_codeстрокаложьотсутствуетКод континента
»»»» код_страныстрокаложьотсутствуетКод страны или региона

GET Поиск города

GET /open/ip/dynamic-citys/search

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
country_codeЗапросстрокаДаКод страны или региона
состояниеЗапросстрокаДаКод штата или провинции

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

НазваниеТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод статуса: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
»» список[строка]ложьотсутствуетСписок

Получить список штатов

GET /open/ip/dynamic-states

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKЗапрос выполнен успешноВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод статуса: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетСписок
»»» name_zh_cnстрокаложьотсутствуетНазвание страны или региона
»»» name_enстрокаложьотсутствуетНазвание страны или региона
»»» continent_codeстрокаложьотсутствуетКод континента
»»» код_страныстрокаложьотсутствуетКод страны или региона
»»» элементы[объект]ложьотсутствуетОбласть или провинция
»»»» штатстрокаложьотсутствуетКод названия провинции или штата
»»»» continent_codeстрокаложьотсутствуетКод континента
»»»» код_страныстрокаложьотсутствуетКод страны или региона

GET Поиск штата/провинции

GET /open/ip/dynamic-states/search

Параметры запроса

ИмяМестоположениеТипОбязательныйОписание
country_codeЗапросстрокаДаКод страны или региона

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешный запросВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательныйОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени
» msgстрокаложьотсутствуетСообщение о состоянии
» dataобъектложьотсутствуетотсутствует
»» список[строка]ложьотсутствуетСписок

GET Извлечь Список Купленных Статических IP-адресов

GET /open/ip/get-static-ip

Параметры Запроса

ИмяМестоположениеТипОбязательныйОписание
country_codeЗапросстрокаНетКод страны или региона
product_typeЗапросНомерНетТип продукта, 25: Статический резидентный IP, 14: IP-адрес дата-центра
trade_noЗапросстрокаНетФильтровать IP-адреса по номеру заказа
страницаЗапросНомерНетНомер страницы
sizeЗапросНомерНетРазмер страницы
статусЗапросНомерНетСтатус: 1 — действителен, 2 — недействителен, 3 — скоро истекает, 4 — на обслуживании

Значение перечисления

СвойствоЗначение
product_type14
product_type25
статус1
статус2
статус3
статус4

Пример возврата

Ответ 200

{}

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKотсутствуетВстроенный

Структура возвращаемых данных


GET Получить количество статических IP-адресов в зоне продаж

GET /open/static-ip-region

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
ispЗапросстрокаНетТип IP

Описание типа IP

Тип IPОписание
1Статический IP для дома
0Статический IP для дата-центра

Пример возврата

Ответ 200

{
	"code": 200,
	"msg": "请求成功",
	"data": {
		"list": [
			{
				"code": "US",
				"number": 55
			}
		]
	}
}

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKотсутствуетВстроенный

Структура возвращаемых данных

Код состояния 200

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния, 200 Успех
» msgстрокаложьотсутствуетТекст сообщения о состоянии
» dataобъектложьотсутствуетотсутствует
»» список[объект]ложьотсутствуетотсутствует
»»» кодстрокаложьотсутствуетКод страны или региона
»»» числоцелое числоложьотсутствуетКоличество

Управление заказами

ПОЛУЧИТЬ список заказов

GET /open/order/list

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
page_noЗапросцелое числоНетотсутствует
размер_страницыЗапросцелое числоНетотсутствует
trade_noЗапросстрокаНетНомер заказа
статусЗапросцелое числоНетСтатус заказа
product_typeЗапросцелое числоНетТип продукта

Подробное описание

статус: Статус заказа

СтатусОписание
0Ожидает оплаты
1Оплачено
2Отменено из-за истечения времени ожидания
3Возвращено

product_type: Тип продукта

Тип продуктаОписание
3Пополнить баланс
9Динамический пакет трафика
11Динамический глобальный почасовой пакет V2
12Долгосрочный пакет трафика IDC
13Пакет статического IP-трафика для жилых помещений
14Пакет статического IP для дата-центров
15Долгосрочный пакет трафика для интернет-провайдеров
16Пакет статического трафика
17Пакет динамических IP-адресов
18веб-скрейпер
19Продление статического IP-адреса
20Квота на замену статического IP-адреса
21Пакет статического трафика v2
24Дополнение "Статический трафик"
25Пакет статического IP-адреса для дома
26Завершение заказа. Некоторые каналы оплаты требуют от пользователей ручного ввода суммы, например, виртуальная валюта. В случае нехватки средств необходимо обратиться в службу поддержки для внесения дополнительного платежа через этот продукт.
27Serp
28Видео

Значение перечисления

СвойствоЗначение
статус0
статус1
статус2
статус3
product_type3
product_type9
product_type11
product_type12
product_type14
product_type16
product_type17
product_type18
product_type19
product_type21
product_type24
product_type25
product_type26
product_type27
product_type28

Пример возврата

Ответ 200

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

Результат возврата

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспехВстроенный

Структура возвращаемых данных


POST Запрос на создание заказа

POST /open/order/create

В связи с разнообразием пакетов и различными конфигурациями для каждого пакета, пожалуйста, заполняйте параметры в соответствии с реальной ситуацией. Неправильно заполненные параметры могут привести к сбою при создании заказа.

Примеры:

Продлить статический 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", // 可选 优惠券
  }

Параметры тела запроса

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

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
телотелообъектДаотсутствует
» pidтелоцелое числоДаID пакета
» upidsтелострокаНетСписок идентификаторов пакетов продления
» суммателоНомерНетНовое количество в упаковке
» pm_idтелоцелое числоДаИдентификатор способа оплаты
» region_listтелострокаНетУкажите регион + количество при покупке статического IP-адреса
» coupon_snтелострокаНетКод купона
» use_invitation_registration_discountтелологический типНетИспользовать скидку при регистрации по приглашению
» renew_durationтелоцелое числоНетПродолжительность продления - Статический IP опционально
» product_sku_bandwidth_idтелоцелое числоНетПакет 11: ID пакета пропускной способности
» product_sku_concurrency_idтелоцелое числоНетПакет 11: ID пакета параллелизма
» recharge_amountтелоцелое числоНетПакет 3: Сумма пополнения

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешно созданоВстроенный

Структура возвращаемых данных


POST Отмена заказа

POST /open/order/close

Параметры тела запроса

{
	"trade_no": "string"
}

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
телотелообъектДаотсутствует
» trade_noтелострокаДаотсутствует

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKОперация прошла успешноНет

Управление пользователями

GET Получить информацию о пользователе - Пока не открыто

GET /open/user/info

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспехВстроенный

Структура возвращаемых данных


Управление платежами

GET Получить список способов оплаты

GET /open/payment/groups

Параметры запроса

ИмяМестоположениеТипОбязательноОписание
trade_noЗапросстрокаНетНомер заказа — можно передать, когда для некоторых заказов необходимо получить определенный способ оплаты

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKУспешно полученоВстроенный

Структура возвращаемых данных

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод статуса: 200 Success, 3 invalid app_key, 156 account not real-name authenticated
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
»» имястрокаложьотсутствуетНазвание группы
»» логотипыstring[]ложьотсутствуетСписок значков группы
»» элементыobject[]ложьотсутствуетСгруппированный список элементов
»»» idцелое числоложьотсутствуетИдентификатор способа оплаты
»»» названиестрокаложьотсутствуетНазвание способа оплаты
»»» логотипстрокаложьотсутствуетЛоготип способа оплаты
»»» группастрокаложьотсутствуетИдентификатор группировки способов оплаты
»»» отключенологический типложьотсутствуетСледует ли отключить (по умолчанию false)
»» минНомерложьотсутствуетМинимальная сумма
»»» максНомерложьотсутствуетМаксимальная сумма

Маркетинг

ПОЛУЧИТЬ Коэффициент бонуса за пополнение счета

GET /open/activity/balance-recharge-gift-ratio

Коэффициент бонуса за пополнение счета

Пример возврата

Ответ 200

{
	"code": 0,
	"msg": "操作成功",
	"data": {
		"list": [
			{
				"amount": 100,
				"ratio": 1.2
			}
		]
	}
}

Возвращаемый результат

Код состоянияЗначение кода состоянияОписаниеМодель данных
200OKOKВстроенный

Структура возвращаемых данных

ИмяТипОбязательноОграничениеКитайское названиеОписание
» кодцелое числоложьотсутствуетКод состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности реального имени
» msgстрокаложьотсутствуетСообщение о статусе
» dataобъектложьотсутствуетотсутствует
» список[объект]ложьотсутствуетотсутствует
»» суммацелое числоложьотсутствуетСумма пополнения
»» коэффициентНомерложьотсутствуетКоэффициент пополнения

Описание структуры данных (схемы)

productTypes (Типы пакетов)

ПолеТипОписание
product_typeцелое числоТип пакета

Описание дополнительных значений:

ЗначениеЗначение
9Динамический пакет резидентного трафика
11Динамический резидентный IP
14Статический IP-адрес дата-центра
25Статический резидентный IP-адрес

Ключ API

Используется для аутентификации интерфейса, пожалуйста, передавайте его через параметр Query.

Имя параметраМестоположениеТипОбязательноОписание
app_keyЗапросстрокаДаКлюч аутентификации

Общие поля ответа

responseCode

ПолеТипПримерОписание
codeцелое число200Код состояния (200 – успех, 3 означает недействительный app_key)

responseMsg

ПолеТипПримерОписание
сообщениестрокауспехИнформация об ответе

Успешный ответ (SuccessResponse)

{
	"code": 0,
	"message": "操作成功",
	"data": {}
}

Ответ об ошибке (ErrorResponse)

{
	"code": 400,
	"message": "参数错误",
	"errors": {}
}

Пользователь

{
	"id": 0,
	"email": "[email protected]",
	"phone": "string",
	"balance": 0.1,
	"status": 0,
	"is_real_name": true,
	"created_at": "2019-08-24T14:15:22Z"
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
электронная почтастрока(электронная почта)ложьотсутствуетотсутствует
телефонстрокаложьотсутствуетотсутствует
балансчисло (с плавающей точкой)ложьотсутствуетотсутствует
статусцелое числоложьотсутствуетотсутствует
is_real_nameлогический типложьотсутствуетотсутствует
created_atстрока (дата-время)ложьотсутствуетотсутствует

Заказ

{
	"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целое числоложьотсутствуетотсутствует
trade_noстрокаложьотсутствуетотсутствует
product_idцелое числоложьотсутствуетотсутствует
product_nameстрокаложьотсутствуетотсутствует
total_feeчисло (с плавающей точкой)ложьотсутствуетотсутствует
pay_feeчисло (с плавающей точкой)ложьотсутствуетотсутствует
статусцелое числоложьотсутствуетотсутствует
created_atстрока (дата-время)ложьотсутствуетотсутствует

Продукт

{
	"id": 0,
	"name": "string",
	"type": 0,
	"price": 0.1,
	"description": "string"
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
имястрокаложьотсутствуетотсутствует
типцелое числоложьотсутствуетотсутствует
ценачисло (с плавающей точкой)ложьотсутствуетотсутствует
описаниестрокаложьотсутствуетотсутствует

БелыйIp

{
	"id": 0,
	"ip": "string",
	"remark": "string",
	"created_at": "2019-08-24T14:15:22Z"
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
ipстрокаложьотсутствуетотсутствует
примечаниестрокаложьотсутствуетотсутствует
created_atстрока (дата-время)ложьотсутствуетотсутствует

Список разрешенных аккаунтов

{
	"id": 0,
	"username": "string",
	"limit": 0,
	"used": 0,
	"status": 0
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
имя пользователястрокаложьотсутствуетотсутствует
лимитцелое числоложьотсутствуетотсутствует
использованоцелое числоложьотсутствуетотсутствует
статусцелое числоложьотсутствуетотсутствует

Купон

{
	"id": 0,
	"name": "string",
	"code": "string",
	"discount": 0.1,
	"expire_time": "2019-08-24T14:15:22Z"
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
имястрокаложьотсутствуетотсутствует
codeстрокаложьотсутствуетотсутствует
скидкачисло (с плавающей точкой)ложьотсутствуетотсутствует
expire_time (время истечения)строка (дата-время)ложьотсутствуетотсутствует

Статья

{
	"id": 0,
	"title": "string",
	"content": "string",
	"created_at": "2019-08-24T14:15:22Z"
}
ИмяТипОбязательноОграничениеКитайское названиеОписание
idцелое числоложьотсутствуетотсутствует
заголовокстрокаложьотсутствуетотсутствует
содержаниестрокаложьотсутствуетотсутствует
created_atстрока (дата-время)ложьотсутствуетотсутствует

Разбивка на страницы

{
	"total": 0,
	"page_no": 0,
	"page_size": 0,
	"total_pages": 0
}
НазваниеТипОбязательноОграничениеКитайское названиеОбъяснение
всегоцелое числоложьотсутствуетотсутствует
page_noцелое числоложьотсутствуетотсутствует
размер_страницыцелое числоложьотсутствуетотсутствует
всего_страниццелое числоложьотсутствуетотсутствует