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
}
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос выполнен успешно | Встроенный |
Структура возвращаемых данных
Код состояния 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_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
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
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос выполнен успешно | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательный | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о состоянии | |
| » data | null | ложь | отсутствует | отсутствует |
POST Удалить прокси-аккаунт
POST /open/whitelist-account/delete
Обратите внимание, что удаление необратимо, и использованный трафик и другие данные не могут быть запрошены после удаления. Удаление занимает примерно 5 минут, и в течение этого периода может взиматься плата.
Параметры тела запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Имя | Местоположение | Тип | Обязательный | Описание |
|---|---|---|---|---|
| Тело запроса | тело | объект | Нет | отсутствует |
| » app_key | тело | строка | Нет | Ключ авторизации |
| » аккаунты | тело запроса | строка | Нет | Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,). |
Пример возврата
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о состоянии | |
| » data | null | ложь | отсутствует | отсутствует |
POST Отключить прокси-аккаунт
POST /open/whitelist-account/disable
Отключение занимает примерно 5 минут, в течение которых может взиматься плата.
Параметры тела запроса
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Имя | Местоположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| тело | тело | объект | Нет | ни один |
| » app_key | тело | строка | Нет | Ключ авторизации |
| » аккаунты | тело | строка | Нет | Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,). |
Пример возврата
Ответ 200
{
"code": 200,
"msg": "string",
"data": null
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос выполнен успешно | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательный | Ограничение | Китайское название | Пояснение |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 – успех, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о статусе | |
| » data | null | ложь | отсутствует | отсутствует |
POST Включить прокси-аккаунт
POST /open/whitelist-account/enable
Параметры запроса в теле
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Параметры запроса
| Имя | Местоположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| тело | тело | объект | Нет | отсутствует |
| » app_key | тело | строка | Нет | Ключ авторизации |
| » аккаунты | тело | строка | Нет | Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделяйте прокси-аккаунты английскими запятыми (,). |
Пример возврата
Ответ 200
{
"code": 200,
"msg": "string",
"data": null
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о состоянии | |
| » data | null | ложь | отсутствует | отсутствует |
POST Изменить пароль прокси-аккаунта
POST /open/whitelist-account/change-password
Обратите внимание, что после изменения действует 5-минутный период ожидания, в течение которого старый пароль все еще может использоваться в обычном режиме.
Параметры запроса в теле
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"password": "pass"
}
Параметры запроса
| Имя | Местоположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| тело | тело | объект | Нет | отсутствует |
| » app_key | тело | строка | Нет | Ключ авторизации |
| » учетная запись | тело | строка | Нет | Прокси-аккаунт, поддерживает только цифры и буквы. |
| » пароль | тело | строка | Нет | Новый пароль для прокси-аккаунта, поддерживаются только цифры и буквы. |
Пример возврата
Ответ 200
{
"code": 200,
"msg": "string",
"data": null
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Название | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 Успех, 3 недействительных app_key, 156 учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о состоянии | |
| » data | null | ложь | отсутствует | отсутствует |
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
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 200 Успех, 3 недействительный app_key, 156 учетная запись не прошла проверку подлинности по реальному имени | |
| » msg | строка | ложь | отсутствует | Сообщение о состоянии | |
| » data | null | ложь | отсутствует | отсутствует |
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
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос выполнен успешно | Встроенный |
Структура возвращаемых данных
Код состояния 200
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код статуса: 200 Success, 3 invalid app_key, 156 account not real-name authenticated | |
| » msg | строка | ложь | отсутствует | Сообщение о статусе | |
| » data | null | ложь | отсутствует | отсутствует |
Запрос журнала трафика
ПОЛУЧИТЬ агрегированный трафик использования по дням
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
}
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
Извлечение 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"
]
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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
}
]
}
]
}
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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"]
}
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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
}
]
}
]
}
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Запрос выполнен успешно | Встроенный |
Структура возвращаемых данных
Код состояния 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"]
}
}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешный запрос | Встроенный |
Структура возвращаемых данных
Код состояния 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_type | 14 |
| product_type | 25 |
| статус | 1 |
| статус | 2 |
| статус | 3 |
| статус | 4 |
Пример возврата
Ответ 200
{}
Результат возврата
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | отсутствует | Встроенный |
Структура возвращаемых данных
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
}
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | отсутствует | Встроенный |
Структура возвращаемых данных
Код состояния 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 | Завершение заказа. Некоторые каналы оплаты требуют от пользователей ручного ввода суммы, например, виртуальная валюта. В случае нехватки средств необходимо обратиться в службу поддержки для внесения дополнительного платежа через этот продукт. |
| 27 | Serp |
| 28 | Видео |
Значение перечисления
| Свойство | Значение |
|---|---|
| статус | 0 |
| статус | 1 |
| статус | 2 |
| статус | 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
{
"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 | Успех | Встроенный |
Структура возвращаемых данных
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"
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешно создано | Встроенный |
Структура возвращаемых данных
POST Отмена заказа
POST /open/order/close
Параметры тела запроса
{
"trade_no": "string"
}
Параметры запроса
| Имя | Местоположение | Тип | Обязательно | Описание |
|---|---|---|---|---|
| тело | тело | объект | Да | отсутствует |
| » trade_no | тело | строка | Да | отсутствует |
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Операция прошла успешно | Нет |
Управление пользователями
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"
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успех | Встроенный |
Структура возвращаемых данных
Управление платежами
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
}
]
}
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | Успешно получено | Встроенный |
Структура возвращаемых данных
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код статуса: 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
}
]
}
}
Возвращаемый результат
| Код состояния | Значение кода состояния | Описание | Модель данных |
|---|---|---|---|
| 200 | OK | OK | Встроенный |
Структура возвращаемых данных
| Имя | Тип | Обязательно | Ограничение | Китайское название | Описание |
|---|---|---|---|---|---|
| » код | целое число | ложь | отсутствует | Код состояния: 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 | целое число | ложь | отсутствует | отсутствует | |
| размер_страницы | целое число | ложь | отсутствует | отсутствует | |
| всего_страниц | целое число | ложь | отсутствует | отсутствует |