ProxyLite OpenAPI

Поддерживает управление личными учетными записями, ресурсами агентов и групповыми биллингами через префикс OpenAPI сайта.

Метод аутентификации зависит от определения безопасности каждой операции:

  • apiKeyAuth: передать личный или групповой ключ API через параметр запроса app_key; бэкэнд также совместим с параметрами key, appkey, openid и параметрами тела запроса POST.
  • BearerAuth: авторизация: носитель <JWT>, используемый для токенов входа в Интернет. Не думайте о ключах API как о JWT.
  • Командный API-ключ привязан к фиксированной команде; интерфейсы, поддерживающие пространство команды, могут опускать team_id, а явный ввод должен соответствовать команде привязки клавиш.
  • Интерфейсы, поддерживающие только личное пространство, будут отклонять командный ключ API; командные операции по-прежнему следуют разрешениям на ресурсы члена холдинга.

Ответ JSON содержит код, сообщение, данные, request_id. код=200 означает, что бизнес успешен; HTTP 200 также может содержать код бизнес-ошибки. msg меняется в зависимости от языка запроса, и клиент должен использовать код для определения результата. Некоторые интерфейсы экспорта также поддерживают текст, CSV или XML; подробности см. в определении операции. Поля суммы, потока, даты и подкачки подчиняются схеме каждого интерфейса.

Базовые URL:

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

  • HTTP-аутентификация, схема: bearer
  • API-ключ (apiKeyAuth)
    • Имя параметра: app_key, in: query. Личный или командный ключ API. Рекомендуемый параметр запроса app_key; также совместим с ключом/appkey/openid и телом запроса POST. Ключи команды могут получить доступ только к поддерживаемым интерфейсам связанной команды.

Управление счетами агентства

Список аккаунтов агентов (GET /end-point/whitelist-account/list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; опустите личное пространство или передайте пустую строку; Ключ команды можно опустить и он должен соответствовать ключу при передаче.

Примеры ответов

Ответ 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Запрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» coderesponseCodefalseнетКод состояния, 200 успешно, 3 app_key недействительны
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» idintegerfalseнетНомер счета
»»» usernamestringfalseнетИмя учетной записи агента
»»» passwordstringfalseнетПароль от учетной записи агента
»»» created_atstringfalseнетДобавить время
»»» remarkstringfalseнетПримечания
»»» product_typeproductTypesfalseнетТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений
»»» usage_flowintegerfalseнетИспользованный трафик, ед.: КБ
»»» limit_flowintegerfalseнетНастраиваемый лимит трафика: максимальная единица ГБ — 102400, 0 — без ограничений.
»»» statusintegerfalseнетСтатус «Включено»: 1 включен, 0 отключен.

Допустимые значения

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

Обнаружение ограничений трафика, которые можно установить на прокси-аккаунты

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» accountbodystringfalseПередайте имя учетной записи при редактировании существующей учетной записи агента.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
isAgent0
isAgent1

Получите квоту субсчета динамического агента и использованное количество.

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/child-account

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Добавить аккаунт агента. (POST /end-point/whitelist-account/add)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueПароль учетной записи. Введите его в формате имя пользователя:пароль. Учетная запись и пароль поддерживают только цифры и буквы. Запрещено вводить любые специальные символы и пробелы. Двоеточие разделяет учетную запись и пароль. Поддерживается пакетное добавление, а учетные записи агентов разделяются английскими запятыми (,).
» remarkbodystringfalseОписание аккаунта агента
» product_typebodyproductTypesfalseТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений

Допустимые значения

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Удалить прокси-аккаунт (POST /end-point/whitelist-account/delete)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

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

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Отключить прокси-аккаунт (POST /end-point/whitelist-account/disable)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

Для отключения потребуется время ожидания примерно 5 минут, в течение этого времени еще может взиматься плата.

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Включить прокси-аккаунт (POST /end-point/whitelist-account/enable)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Изменить пароль учетной записи агента

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-password

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

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountbodystringtrueАккаунт агента, поддерживаются только цифры и буквы.
» passwordbodystringtrueНовый пароль для учетной записи агента поддерживает только цифры и буквы.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

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

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-remark

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountbodystringtrueАккаунт агента, поддерживаются только цифры и буквы.
» remarkbodystringtrueНовые примечания для аккаунтов агентств длиной до 32 китайских иероглифов или 64 английских символов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

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

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-limit

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

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountbodystringtrueАккаунт агента, поддерживаются только цифры и буквы.
» limitbodyintegerfalseЛимит трафика, единица измерения: ГБ, 0 означает отсутствие верхнего предела.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Быстро создать учетную запись агента

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» product_typebodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKНовая учетная запись и пароль будут возвращены, когда бизнес будет успешным.Inline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетnone
» msgstringfalseнетnone
» request_idstringfalseнетnone
» dataanyfalseнетnone

oneOf

ИмяТипОбязательноОграниченияОписание
»» anonymousobjectfalseнетnone
»»» usernamestringtrueнетnone
»»» passwordstringtrueнетnone

xor

ИмяТипОбязательноОграниченияОписание
»» anonymousnullfalseнетnone

Изменить дневной лимит трафика агентского аккаунта

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-daily-limit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» accountbodystringtrueнет
» daily_limitbodyintegerfalseЕдиница ГБ

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Изменить информацию об учетной записи агента (POST /end-point/whitelist-account/change)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» accountbodystringtrueнет
» passwordbodystringfalseнет
» remarkbodystringfalseнет
» limitbodyintegerfalseОбщий лимит трафика в ГБ
» daily_limitbodyintegerfalseСуточный лимит трафика в ГБ
» statusbodyintegerfalseнет
» udpbodyintegerfalseнет

Допустимые значения

ParameterValue
» status0
» status1
» udp0
» udp1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Обновить кэш аутентификации учетной записи прокси текущего ресурсного пространства.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Квота аккаунта агентства для указанных типов продуктов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quota

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
product_typequeryintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетnone
» msgstringfalseнетnone
» request_idstringfalseнетnone
» dataobjectfalseнетnone
»» usageintegertrueнетnone
»» limitintegertrueнетnone
»» expandintegertrueнетnone

Квоты агентского счета для всех типов продуктов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quotas

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетnone
» msgstringfalseнетnone
» request_idstringfalseнетnone
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» product_typeintegerfalseнетnone
»»» limitintegerfalseнетnone
»»» usageintegerfalseнетnone

Список аккаунтов агентов (GET /end-point/proxy-account/list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-account/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; опустите личное пространство или передайте пустую строку; Ключ команды можно опустить и он должен соответствовать ключу при передаче.

Примеры ответов

Ответ 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Запрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» coderesponseCodefalseнетКод состояния, 200 успешно, 3 app_key недействительны
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» idintegerfalseнетНомер счета
»»» usernamestringfalseнетИмя учетной записи агента
»»» passwordstringfalseнетПароль от учетной записи агента
»»» created_atstringfalseнетДобавить время
»»» remarkstringfalseнетПримечания
»»» product_typeproductTypesfalseнетТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений
»»» usage_flowintegerfalseнетИспользованный трафик, ед.: КБ
»»» limit_flowintegerfalseнетНастраиваемый лимит трафика: максимальная единица ГБ — 102400, 0 — без ограничений.
»»» statusintegerfalseнетСтатус «Включено»: 1 включен, 0 отключен.

Допустимые значения

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

Добавить аккаунт агента. (POST /end-point/proxy-account/add)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/add

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueПароль учетной записи. Введите его в формате имя пользователя:пароль. Учетная запись и пароль поддерживают только цифры и буквы. Запрещено вводить любые специальные символы и пробелы. Двоеточие разделяет учетную запись и пароль. Поддерживается пакетное добавление, а учетные записи агентов разделяются английскими запятыми (,).
» remarkbodystringfalseОписание аккаунта агента
» product_typebodyproductTypesfalseТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений

Допустимые значения

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Удалить прокси-аккаунт (POST /end-point/proxy-account/delete)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/delete

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

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Включить прокси-аккаунт (POST /end-point/proxy-account/enable)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/enable

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Отключить прокси-аккаунт (POST /end-point/proxy-account/disable)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/disable

Для отключения потребуется время ожидания примерно 5 минут, в течение этого времени еще может взиматься плата.

Body parameter

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

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountsbodystringtrueАккаунт агента, поддерживаются только цифры и буквы. Поддержка пакетных операций, английские запятые (,) для отдельных учетных записей агентов.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Изменить информацию об учетной записи агента (POST /end-point/proxy-account/change)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

Измените пароль учетной записи прокси, примечания, лимит трафика, дневной лимит трафика, включенный статус или переключатель UDP.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» accountbodystringtrueИмя учетной записи агента
» passwordbodystringfalseНовый пароль, 6-16 цифр или букв; если он не передан, он не будет изменен.
» remarkbodystringfalseНовая заметка
» limitbodyintegerfalseЛимит трафика, ГБ, 0 означает отсутствие лимита.
» daily_limitbodyintegerfalseСуточный лимит трафика в ГБ, 0 означает отсутствие лимита.
» statusbodyintegerfalseСтатус включен
» udpbodyintegerfalseПереключатель поддержки UDP, действует только для типов пакетов 14, 16, 21 и 25.

Допустимые значения

ParameterValue
» status0
» status1
» udp0
» udp1

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Создать информацию о прокси-соединении

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/format

Поддерживает личные и командные ключи API. Возвращаются только учетные записи агентов, имеющие доступ к текущему пространству ресурсов. Поддерживаются типы пакетов 9, 11 и 12. JSON/XML возвращает структурированный список учетных записей; txt/csv возвращает строку подключения, склеенную в формате f.

Параметры

ИмяРасположениеТипОбязательноОписание
acqueryinteger,stringtrueИдентификатор учетной записи агента или имя пользователя; совместимый аккаунт параметров
aequerystringfalseнет
stquerystringfalseнет
ctquerystringfalseнет
lfqueryintegerfalseнет
nqueryintegerfalseнет
fqueryintegerfalseВлияет только на формат строки подключения txt/csv.
typequerystringfalseнет
lbquerystringfalseнет
epquerystringfalseнет
team_idqueryResourceSpaceIdfalseнет

Допустимые значения

ParameterValue
f1
f2
f3
f4
f5
typejson
typexml
typetxt
typecsv

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}

"string"

<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.WebV1SuccessResponse

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

Создание заказа, запрос, отмена и т. д.

список заказов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

Заказы в командном пространстве дополнительно возвращают создателя с указанием фактического члена заказа; администраторы и суперадминистраторы могут видеть полную контактную информацию, а другие роли возвращают менее конфиденциальную контактную информацию.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор пространства ресурса заказа; личное пространство опустить или передать пустую строку
page_noqueryintegerfalseнет
page_sizequeryintegerfalseнет
trade_noquerystringfalseномер заказа
start_timequerystring(date-time)falseВремя начала (включительно), например 2024-01-01 00:00:00.
end_timequerystring(date-time)falseВремя окончания (не включено)
statusqueryintegerfalseСтатус заказа
product_typequeryintegerfalseтип продукта
invoicequeryintegerfalseСтатус счета: 0 без ограничений 1 счет выставлен -1 счет не выставлен (может быть перевыставлен)
pay_fee_statusqueryintegerfalseПроверка длинных и коротких платежей: 1 Переплата 2 Недоплата

Detailed descriptions

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

СтатусОписание
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Серп
28Видео

Допустимые значения

ParameterValue
status0
status1
status2
status3
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
invoice-1
invoice0
invoice1
pay_fee_status1
pay_fee_status2

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKуспехInline

Схема ответа

Создать заказ

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

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

примеры:

Обновить статический IP-адрес

{
    "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
    "upids": "1,2,3,4,5,6", // Получаем соответствующее поле идентификатора из интерфейса /openapi/ip/get-static-ip
    "pm_id": 1 // Получено из интерфейса /openapi/Payment/list или /openapi/Payment/groups.
  }

Покупка статического жилого IP

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  "pm_id": идентификатор метода оплаты, // полученный из интерфейса /openapi/pay/list или /openapi/pay/groups
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Формат: регион, количество, ASN|регион, количество, ASN (номер ASN необязателен)
}

Покупка статического IP-адреса дата-центра

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  "pm_id": идентификатор метода оплаты, // полученный из интерфейса /openapi/pay/list или /openapi/pay/groups
  "region_list": "JP,15,333|DE,10,444|US,5,555" // Формат: регион, количество, ASN|регион, количество, ASN (номер ASN необязателен)
}

Динамическая покупка жилого трафика

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  «pm_id»: идентификатор метода оплаты // Получен из интерфейса /openapi/pay/list или /openapi/pay/groups.
}

Покупка статического ротационного трафика

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  «pm_id»: идентификатор метода оплаты // Получен из интерфейса /openapi/pay/list или /openapi/pay/groups.
}

Динамическая покупка безлимитного трафика

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  "pm_id": идентификатор метода оплаты, // полученный из интерфейса /openapi/pay/list или /openapi/pay/groups
  «product_sku_bandwidth_id»: идентификатор спецификации пропускной способности,
  «product_sku_concurrency_id»: идентификатор спецификации параллелизма.
}

Пополнение баланса

{
  "pid": идентификатор пакета, // полученный из интерфейса /openapi/product
  "pm_id": идентификатор метода оплаты, // полученный из интерфейса /openapi/pay/list или /openapi/pay/groups
  "recharge_amount": сумма пополнения
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "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,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» pidbodyintegertrueИдентификатор пакета из поля id, возвращаемого интерфейсом /openapi/product.
» upidsbodystringfalseСписок идентификаторов пакетов продления (через запятую) из поля id, возвращаемого интерфейсом /openapi/user-product/list или /openapi/ip/get-static-ip.
» amountbodynumberfalseКоличество приобретенных новых пакетов
» pm_idbodyintegertrueИдентификатор способа оплаты из поля id, возвращаемого интерфейсом /openapi/Payment/list или /openapi/Payment/groups.
» region_listbodystringfalseПри покупке статического IP укажите регион+количество+номер ASN. Формат: регион, количество, ASN
» coupon_snbodystringfalseНомер купона
» use_invitation_registration_discountbodybooleanfalseИспользовать ли скидку на регистрацию приглашения
» renew_durationbodyintegerfalseОбновление статического IP-адреса необязательно.
» product_sku_bandwidth_idbodyintegerfalseПакет 11: Идентификатор пакета пропускной способности
» product_sku_concurrency_idbodyintegerfalseПакет 11: Идентификатор одновременного пакета
» product_sku_duration_idbodyintegerfalseТип пакета=11Обязательно: идентификатор спецификации продолжительности
» etdbodyintegerfalseКратность продолжительности, полученная из пакета Extension_of_time_days, 2 представляет количество дней × 2, цена увеличится.
» recharge_amountbodyintegerfalseПакет 3: Сумма пополнения

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKСоздано успешноInline

Схема ответа

Отменить заказ

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» trade_nobodystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Детали заказа

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
trade_noquerystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Детали заказа V2

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info-v2

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
order_idquerystringtrueЗашифрованный идентификатор заказа на стороне клиента

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP-успех; когда заказ оплачен или отменен, данные заказа могут содержать код бизнес-ошибки.Inline

Схема ответа

Повторное выставление счета для исторических заказов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» trade_no_listbody[string]trueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Заказать предварительную проверку

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

Вызывается перед созданием заказа и используется для предварительного просмотра цен, скидок, сведений о продлении IP-адреса и т. д. Фактически заказ не будет создан. Параметры точно такие же, как у /openapi/order/create.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» pidbodyintegertrueИдентификатор пакета
» upidsbodystringfalseПродление IP: список идентификаторов пользовательских пакетов, разделенных запятыми.
» amountbodyintegerfalseКоличество покупки
» pm_idbodyintegertrueИдентификатор способа оплаты
» region_listbodystringfalseСтатический IP-регион покупки + количество, формат: ID региона, количество
» coupon_snbodystringfalseНомер купона
» renew_durationbodystringfalseПериод продления IP: 1м=1 месяц, 2м=2 месяца, em=конец следующего месяца
» product_sku_bandwidth_idbodyintegerfalseТип пакета=11Обязательно: идентификатор спецификации пропускной способности
» product_sku_concurrency_idbodyintegerfalseТип пакета=11Обязательно: идентификатор спецификации параллелизма.
» product_sku_duration_idbodyintegerfalseТип пакета=11Обязательно: идентификатор спецификации продолжительности
» etdbodyintegerfalseДлительность кратна, получена из пакета Extension_of_time_days
» recharge_amountbodynumberfalseТип пакета=3Обязательно: сумма пополнения

Допустимые значения

ParameterValue
» renew_duration1m
» renew_duration2m
» renew_durationem

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKПредполетная подготовка прошла успешноInline

Схема ответа

Управление ключами API

Управление ключами API для личных и групповых ресурсов

Список ключей API

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/api-keys

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
pagequeryintegerfalseнет
pageSizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетnone
» msgstringtrueнетnone
» request_idstringtrueнетnone
» dataobjecttrueнетnone
»» list[UserApiKeyMetadata]trueнетnone
»»» idintegertrueнетAPI Key ID
»»» api_keystringtrueнетОтвет создания – это полный Ключ; список команд — это замаскированное значение
»»» team_user_idintegertrueнетКлюч группы фактически содержит идентификатор участника, а личный ключ равен 0.
»»» remarkstringtrueнетПримечания
»»» statusintegertrueнет0=отключить, 1=включить
»»» created_atstringtrueнетвремя создания
»»» updated_atstring,nullfalseнетВремя обновления
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» pageSizeintegertrueнетnone

Допустимые значения

СвойствоЗначение
status0
status1

Создать ключ API

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» remarkbodystringfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKВерните полный ключ API, когда бизнес будет успешным, только на этот разInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1

Включить ключ API

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueAPI Key ID

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Деактивировать ключ API

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueAPI Key ID

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Удалить ключ API

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueAPI Key ID

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Изменить примечания к ключу API

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueнет
» remarkbodystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Ежемесячный счет за продление

Выставление счетов в режиме реального времени, предварительная проверка, размещение заказов и история ежемесячных совокупных продлений

Текущий ежемесячный сводный счет за продление

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
typecurrent
typenext

Проверка ежемесячных сводных заказов на продление

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyMonthlyRenewalRequesttrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
typecurrent
typenext

Создайте ежемесячный сводный заказ на продление

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyMonthlyRenewalRequesttrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Ежемесячная сводка счетов за историю продления

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill/history

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
trade_noquerystringfalseнет
start_datequerystring(date)falseнет
end_datequerystring(date)falseнет
pagequeryintegerfalseнет
sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Управление счетами

Заголовок счета, приложение для выставления счета и заказы, подлежащие выставлению счетов

Детали заголовка счета-фактуры

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/info

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
invoice_codequerystringfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

Создать или изменить заголовок счета-фактуры

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyanytrueнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешен, данные пустыеInline

Схема ответа

Список заголовков счетов-фактур

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

Удалить заголовок счета-фактуры

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invoice_codebodystringtrueнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешен, данные пустыеInline

Схема ответа

Список записей для выставления счетов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/record-list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
statusqueryintegerfalseнет

Допустимые значения

ParameterValue
status0
status1
status2
status3
status4

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

Подать заявку на выставление счета

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invoice_codebodystringtrueнет
» order_idsbody[integer]trueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Отменить заявку на выставление счета

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invoice_idbodyintegertrueнет
» reasonbodystringfalseнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешен, данные пустыеInline

Схема ответа

Статистика суммы счета

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/statistics

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Список заказов, по которым можно выставить счет

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/invoiceable-orders

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Управление командой

Создание команды, запрос, изменение названия и расформирование

Создать команду

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/create

Body parameter

{
  "name": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» namebodystringtrueНазвание команды

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

Список команд, доступных текущему пользователю

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/list

Параметры

ИмяРасположениеТипОбязательноОписание
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

Детали команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/detail

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

Изменить название команды

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» namebodystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

Расформировать команду

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/dissolve

Это могут делать только суперадминистраторы команды. Имя в запросе должно точно совпадать с текущим названием команды. Этот интерфейс обеспечивает двухэтапную проверку операций: код = 348 возвращается, если он не находится в 15-минутном состоянии доверия; Вызывающий должен получить код проверки в соответствии с доступными методами в данных ответа, а затем повторить попытку с помощьюverify_type иverify_code. Может быть вызван повторно, чтобы продолжить незавершенный процесс растворения.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» namebodystringtrueПодтверждение названия команды должно совпадать с текущим названием команды.
» verify_typebodystringfalseВторичный метод проверки; отправить вместе сverify_code, когда требуется проверка
» verify_codebodystringfalseДвухэтапный код проверки; не требуется в 15-минутном состоянии доверия

Допустимые значения

ParameterValue
» verify_typephone
» verify_typeemail
» verify_typewechat
» verify_typetotp

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

Статус расформирования группы запроса

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/dissolve-status

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

член команды

Списки членов команды, корректировка ролей, удаления и выходы

Список членов команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/members

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

Единый список членов команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/people

Действительные члены возвращаются; суперадминистраторы и администраторы также видят ожидающие приглашения. Другие статусы приглашений остаются только в списке истории приглашений.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

Настройка ролей участников

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» team_member_idbodyintegertrueнет
» rolebodyintegertrueнет

Допустимые значения

ParameterValue
» role2
» role3

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

Удалить члена команды

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» team_member_idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен data.status=3Inline

Схема ответа

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

Выйти из команды

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, data.status=2Inline

Схема ответа

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

Приглашение команды

Создание, запрос и обработка приглашений членов команды

Создать командное приглашение

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/create

Создавайте приглашения по зарегистрированному пользователю, адресу электронной почты или номеру мобильного телефона. Если адрес электронной почты или номер мобильного телефона соответствует пользователю на этом сайте, ответ будет нормализован до приглашения_type=1. Внешний интерфейс может отправить шаблон относительного пути URL-адреса приглашения этого сайта, а сервер только заменяет в нем одноразовым токеном приглашения. После того, как незарегистрированная цель зарегистрируется с использованием приглашенного номера мобильного телефона или завершит проверку с использованием приглашенного электронного письма, сервер привяжет все еще действительное приглашение к новому пользователю, поменяет токен и повторно отправит только непрочитанное сообщение на сайте; старый токен в исходном электронном письме или текстовом сообщении станет недействительным. Если приглашение по электронной почте не было автоматически привязано, текущую учетную запись, зарегистрированную с приглашенным адресом электронной почты, можно принять напрямую, не дожидаясь email_verify.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invite_typebodyintegertrue1=Зарегистрированный пользователь, 2=Электронная почта, 3=Номер мобильного телефона
» rolebodyintegertrue2=администратор, 3=обычный член
» user_idbodyintegerfalseТребуется, если инвайт_тип=1
» emailbodystring(email)falseТребуется, если инвайт_тип=2
» country_codebodyintegerfalseТребуется, если инвайт_тип=3
» phonebodystringfalseТребуется, если инвайт_тип=3
» invitation_url_templatebodystringfalseШаблон относительного пути, определенный в интерфейсе этого веб-сайта; должен начинаться с одного /, не должен содержать доменных имен или символов новой строки и должен и может содержать только один заполнитель
» anonymousbodyobjectfalseнет
»» invite_typebodyanyfalseнет
» anonymousbodyobjectfalseнет
»» invite_typebodyanyfalseнет
» anonymousbodyobjectfalseнет
»» invite_typebodyanyfalseнет

Допустимые значения

ParameterValue
» invite_type1
» invite_type2
» invite_type3
» role2
» role3

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответа, 200 означает успех в бизнесеInline

Схема ответа

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

Список приглашенных команд

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/invitations

Доступно только суперадминистраторам или администраторам команды; ожидающие приглашения, срок действия которых истек, будут обновлены до истекших перед возвращением.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueПубличный имидж команды
pagequeryintegerfalseНомер страницы, начиная с 1
page_sizequeryintegerfalseКоличество на странице

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

Предварительный просмотр приглашения команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /end-point/team/invitations/preview

Предварительный просмотр приглашений анонимно, используя одноразовый пригласительный_токен; В ссылке не используется цифровой идентификатор приглашения.

Параметры

ИмяРасположениеТипОбязательноОписание
invitation_tokenquerystringtrueНепустой одноразовый токен открытого текста, передаваемый по ссылке приглашения.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
role2
role3
status0
status1
status2
status3
status4

Повторно отправить уведомление о приглашении в команду

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/resend

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

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invitation_idbodyintegertrueИдентификатор приглашения

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

Принять приглашение команды

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/accept

Пользователь, вошедший в систему в данный момент, использует одноразовый маркер приглашения для принятия приглашения, который должен соответствовать цели приглашения и принадлежать сайту, которому принадлежит приглашение; нет необходимости передавать team_id.

Body parameter

{
  "invitation_token": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» invitation_tokenbodystringtrueТокен одноразового приглашения с открытым текстом

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные являются объектом-членомInline

Схема ответа

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

Отклонить приглашение команды

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/reject

Пользователь, вошедший в систему в настоящий момент, использует одноразовый маркер приглашения, чтобы отклонять приглашения, соответствующие этому пользователю; нет необходимости передавать team_id.

Body parameter

{
  "invitation_token": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» invitation_tokenbodystringtrueТокен одноразового приглашения с открытым текстом

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, data.status=2Inline

Схема ответа

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

Отменить приглашение в команду

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/cancel

Чтобы отменить ожидающее приглашение в указанную команду, оператор должен иметь право приглашать целевого персонажа.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» invitation_idbodyintegertrueИдентификатор приглашения

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен data.status=3Inline

Схема ответа

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

Активы команды

Запрос активов команды и передача личного/командного пространства

Информация о пакете команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/product-info

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

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Список активов команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Личные активы, которые можно передать команде

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets/personal-candidates

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Передача личных активов команде

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Активы команды возвращены отдельным лицам

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Управление баллами

Информация о пакете баллов, автоматическое пополнение, учет потребления и статистика

Получить информацию о пакете баллов (GET /web_v1/credit/info)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

Запросите сводную информацию о пакете точек текущего пространства ресурсов. Для группового пространства требуется разрешение USE_ASSETS; этот интерфейс поддерживает статус входа, личный ключ API и ключ API команды одновременно.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опущено или передана пустая строка; Ключ API команды можно опустить и он должен соответствовать ключу при передаче.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные представляют собой уровень баллов, общую сумму, оставшуюся сумму, время сброса и статус автоматического пополнения.Inline

Схема ответа

Настройте баланс для автоматического пополнения баллов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

Установите переключатель автоматического пополнения текущего ресурсного пространства в состоянии входа в систему. Для пространства группы требуется разрешение USE_OWNER_PAYMENT_CAPABILITIES, в настоящее время работать могут только суперадминистраторы команды; пространство команды закрыто по умолчанию.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» statusbodyintegertrue0=выкл., 1=вкл.

Допустимые значения

ParameterValue
» status0
» status1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, data.status — это обновленный статус коммутатора.Inline

Схема ответа

Получить запись о потреблении баллов (GET /web_v1/credit/consumption-logs)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

Запросите запись потребления баллов текущего пространства ресурсов в состоянии входа или на странице ключа API. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет
start_datequerystring(date)falseДата начала, интерпретируемая часовым поясом сайта
end_datequerystring(date)falseДата окончания, интерпретируемая часовым поясом сайта
consumption_typequerystringfalseТип потребления

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные включают список, страницу, размер_страницы, общее количество_страниц и общее_страницу.Inline

Схема ответа

Получить баллы, сбросить запись (GET /web_v1/credit/reset-logs)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

Запросите запись сброса точек текущего пространства ресурсов в состоянии входа или на странице ключа API. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; Когда бизнес успешен, данные содержат записи сброса точек и информацию о подкачке.Inline

Схема ответа

Получить статистику по баллам (GET /web_v1/credit/stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

Войдите в систему или используйте ключ API, чтобы запросить статистику баллов, агрегированную по типу потребления текущего ресурсного пространства. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, интерпретируемая часовым поясом сайта
end_datequerystring(date)falseДата окончания, интерпретируемая часовым поясом сайта

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат by_type и totalInline

Схема ответа

Получайте ежедневную статистику по баллам (GET /web_v1/credit/daily-stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

Войдите в систему или используйте ключ API, чтобы запросить ежедневное потребление баллов текущего пространства ресурсов, которое по умолчанию равно последним 7 дням. Обычные члены команды возвращают только фактическое потребление; администраторы, суперадминистраторы и финансовые участники с разрешениями VIEW_BILLING возвращают полные данные команды. Журналы команд незарегистрированных участников-потребителей видны только в полном представлении. Запрос ключа API может содержать до 31 натуральных дней (включительно), а дата начала не может быть позже даты окончания.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, по умолчанию 6 дней назад.
end_datequerystring(date)falseДата окончания, по умолчанию — сегодня.
consumption_typequerystringfalseДополнительные типы потребления
fill_gapsqueryintegerfalseЗаполнять ли недостающие даты

Допустимые значения

ParameterValue
fill_gaps0
fill_gaps1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат daily_stats и сводкуInline

Схема ответа

Получайте почасовую статистику по баллам (GET /web_v1/credit/hourly-stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

Войдите в систему или используйте ключ API, чтобы запросить почасовое потребление баллов текущего пространства ресурсов, которое по умолчанию равно последним 7 дням. Для групповых пространств требуется разрешение VIEW_BILLING. Запрос ключа API может содержать до 31 натуральных дней (включительно), а дата начала не может быть позже даты окончания.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, по умолчанию 6 дней назад.
end_datequerystring(date)falseДата окончания, по умолчанию — сегодня.
consumption_typequerystringfalseДополнительные типы потребления
fill_gapsqueryintegerfalseЗаполнять ли недостающие часы

Допустимые значения

ParameterValue
fill_gaps0
fill_gaps1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат почасовую_статистику и сводкуInline

Схема ответа

Получить информацию о пакете баллов (GET /end-point/credit/info)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/info

Запросите сводную информацию о пакете точек текущего пространства ресурсов. Для группового пространства требуется разрешение USE_ASSETS; этот интерфейс поддерживает статус входа, личный ключ API и ключ API команды одновременно.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опущено или передана пустая строка; Ключ API команды можно опустить и он должен соответствовать ключу при передаче.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные представляют собой уровень баллов, общую сумму, оставшуюся сумму, время сброса и статус автоматического пополнения.Inline

Схема ответа

Получить запись о потреблении баллов (GET /end-point/credit/consumption-logs)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/consumption-logs

Запросите запись потребления баллов текущего пространства ресурсов в состоянии входа или на странице ключа API. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет
start_datequerystring(date)falseДата начала, интерпретируемая часовым поясом сайта
end_datequerystring(date)falseДата окончания, интерпретируемая часовым поясом сайта
consumption_typequerystringfalseТип потребления

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные включают список, страницу, размер_страницы, общее количество_страниц и общее_страницу.Inline

Схема ответа

Получить баллы, сбросить запись (GET /end-point/credit/reset-logs)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/reset-logs

Запросите запись сброса точек текущего пространства ресурсов в состоянии входа или на странице ключа API. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; Когда бизнес успешен, данные содержат записи сброса точек и информацию о подкачке.Inline

Схема ответа

Получить статистику по баллам (GET /end-point/credit/stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/stats

Войдите в систему или используйте ключ API, чтобы запросить статистику баллов, агрегированную по типу потребления текущего ресурсного пространства. Для групповых пространств требуется разрешение VIEW_BILLING.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, интерпретируемая часовым поясом сайта
end_datequerystring(date)falseДата окончания, интерпретируемая часовым поясом сайта

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат by_type и totalInline

Схема ответа

Получайте ежедневную статистику по баллам (GET /end-point/credit/daily-stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/daily-stats

Войдите в систему или используйте ключ API, чтобы запросить ежедневное потребление баллов текущего пространства ресурсов, которое по умолчанию равно последним 7 дням. Обычные члены команды возвращают только фактическое потребление; администраторы, суперадминистраторы и финансовые участники с разрешениями VIEW_BILLING возвращают полные данные команды. Журналы команд незарегистрированных участников-потребителей видны только в полном представлении. Запрос ключа API может содержать до 31 натуральных дней (включительно), а дата начала не может быть позже даты окончания.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, по умолчанию 6 дней назад.
end_datequerystring(date)falseДата окончания, по умолчанию — сегодня.
consumption_typequerystringfalseДополнительные типы потребления
fill_gapsqueryintegerfalseЗаполнять ли недостающие даты

Допустимые значения

ParameterValue
fill_gaps0
fill_gaps1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат daily_stats и сводкуInline

Схема ответа

Получайте почасовую статистику по баллам (GET /end-point/credit/hourly-stats)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/hourly-stats

Войдите в систему или используйте ключ API, чтобы запросить почасовое потребление баллов текущего пространства ресурсов, которое по умолчанию равно последним 7 дням. Для групповых пространств требуется разрешение VIEW_BILLING. Запрос ключа API может содержать до 31 натуральных дней (включительно), а дата начала не может быть позже даты окончания.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseДата начала, по умолчанию 6 дней назад.
end_datequerystring(date)falseДата окончания, по умолчанию — сегодня.
consumption_typequerystringfalseДополнительные типы потребления
fill_gapsqueryintegerfalseЗаполнять ли недостающие часы

Допустимые значения

ParameterValue
fill_gaps0
fill_gaps1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат почасовую_статистику и сводкуInline

Схема ответа

Xcrawl Activity Log

Xcrawl записи отдельных задач и пакетных задач, подробные сведения и сводный запрос

Получить список последних задач Xcrawl

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

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

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет
endpointquerystringfalseтип конечной точки
statusquerystringfalseнет
start_timequerystringfalseЧасовой пояс пользователя, формат Y-m-d H:i:s
end_timequerystringfalseЧасовой пояс пользователя, включая конечную границу
urlquerystringfalseЦелевой URL-адрес или идентификатор средства очистки данных
job_idquerystringfalseПрефикс идентификатора задачи

Допустимые значения

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат список страниц и метаданныеInline

Схема ответа

Получить результат сканирования Xcrawl

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

В состоянии входа запросите результат сканирования указанной задачи в текущем пространстве ресурсов. Пространство группы требует USE_ASSETS и проверяет владение задачей на основе видимого диапазона учетных данных участника.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
job_idquerystringtrueИдентификатор задачи

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат job_id и scan_resultInline

Схема ответа

Получите подробную информацию и журналы миссии Xcrawl.

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

В состоянии входа запросите текущее пространство ресурсов, чтобы указать одну задачу и сведения о ее результате. Пространство группы требует USE_ASSETS и проверяет владение задачей на основе видимого диапазона учетных данных участника.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
job_idquerystringtrueИдентификатор задачи
pagequeryintegerfalseНомер страницы подрезультата сканирования/данных
page_sizequeryintegerfalseсканирование/данные количества страниц подрезультатов

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат задание и детали, измененные конечной точкой.Inline

Схема ответа

Получить совокупную статистику URL-адресов данных

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

Задачи очистки данных, которые агрегируют текущее пространство ресурсов в состоянии входа в систему. Для групповых пространств требуется USE_ASSETS, а результаты соответствуют видимой области учетных данных участника.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
limitqueryintegerfalseКоличество возврата; 0 возвращает пустой список

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, data.list является результатом агрегации парсера.Inline

Схема ответа

Получить список последних задач пакетного сканирования.

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

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

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет
endpointquerystringfalseТип конечной точки, обычно patch_scrape
statusquerystringfalseнет
start_timequerystringfalseЧасовой пояс пользователя, формат Y-m-d H:i:s
end_timequerystringfalseЧасовой пояс пользователя, включая конечную границу
batch_idquerystringfalseПрефикс идентификатора пакетной задачи

Допустимые значения

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат список страниц и метаданныеInline

Схема ответа

Получение сведений и журналов задачи пакетного сканирования

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

В состоянии входа запросите указанные пакетные задачи и результаты их подэлементов в текущем пространстве ресурсов. Пространство группы требует USE_ASSETS и проверяет владение задачей на основе видимого диапазона учетных данных участника.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
batch_idquerystringtrueИдентификатор пакетной задачи
pagequeryintegerfalseНомер страницы подпункта
page_sizequeryintegerfalseКоличество подстраниц

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; когда бизнес успешен, данные содержат детали заданий и пакетных задач.Inline

Схема ответа

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

Получите обзор вашего личного кабинета

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/account/profile

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Проверить выписку по личному балансу

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/wallet/change-list

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
re_typequeryintegerfalseнет
transaction_typequeryintegerfalseнет
balance_typequeryintegerfalseнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Допустимые значения

ParameterValue
re_type0
re_type1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Экспорт журнала

Создайте задачу экспорта журнала агента.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/create

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается. Время начала должно быть раньше времени окончания, а временной интервал не должен превышать 31 день; одному и тому же пользователю разрешено только одно ожидающее или обрабатывающее задание экспорта, а верхний предел журналов составляет 5 миллионов.

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» start_timebodyintegertrueНачальная временная метка Unix, секунды
» end_timebodyintegertrueконечная временная метка Unix, секунды
» typebodystringfalseнет

Допустимые значения

ParameterValue
» typedynamic
» typehost_pool

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Подробности задачи экспорта журнала запросов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/detail

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
task_idqueryintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

Список задач экспорта журнала запросов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/list

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
pagequeryintegerfalseнет
sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

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

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/cancel

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается. Отменить можно только задачи, находящиеся в состоянии ожидания в очереди, а уже выполненные задачи отменить нельзя.

Body parameter

{
  "task_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» task_idbodyintegertrueнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Купон

Запросить личный список купонов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/list

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» statusbodyintegerfalseнет
» pagebodyintegerfalseнет
» sizebodyintegerfalseнет

Допустимые значения

ParameterValue
» status0
» status1
» status2

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Проверьте детали личного купона

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/info

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Управление уведомлениями

Проверьте уведомления сайта

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/list

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
pagequeryintegerfalseнет
sizequeryintegerfalseнет
readqueryintegerfalseнет
typequeryintegerfalseнет

Допустимые значения

ParameterValue
read0
read1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
read_status0
read_status1

Проверьте детали уведомления сайта

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/detail

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
idqueryintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
read_status0
read_status1

Отметить уведомления сайта как прочитанные

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/read

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» idbodyintegertrueнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Помечать уведомления сайта как прочитанные в пакетном режиме

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/batch-read

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "ids": [
    1
  ]
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» idsbody[integer]trueнет

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Конфигурация канала уведомления о запросе

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notify

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Электронная почта с уведомлением о запросе

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/list

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Сценарий уведомления о запросе

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/scenes

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Запрос сценария подписки по электронной почте

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/email-scenes

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Параметры

ИмяРасположениеТипОбязательноОписание
idqueryintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Конфигурация агента

Запрос переключения кэша личного агента

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-cache/status

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
status0
status1

Установите переключатель кэширования личного прокси

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-cache/change

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "status": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» statusbodyintegertrueнет

Допустимые значения

ParameterValue
» status0
» status1

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Запросить UDP-переключатель личного агента

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-proxy-config/udp

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
enabled0
enabled1

Установить UDP-переключатель личного агента

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-proxy-config/udp

Поддерживается только статус входа в личное пространство или личный ключ API; Ключ API команды не поддерживается.

Body parameter

{
  "udp": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» udpbodyintegertrueнет

Допустимые значения

ParameterValue
» udp0
» udp1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, проверьте бизнес-код, 200 означает успех.Inline

Схема ответа

Допустимые значения

СвойствоЗначение
enabled0
enabled1

Командный кошелек

Запросить кошелек команды

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/detail

Требуется разрешение VIEW_BILLING. Кошелек команды не зависит от суперадминистраторов и личных балансов участников.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Проверьте поток командного кошелька

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/records

Требуется разрешение VIEW_BILLING. Сумма оборота всегда является положительным числом, а увеличение или уменьшение средств обозначается полем направления.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryTeamPublicIdtrueнет
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Допустимые значения

СвойствоЗначение
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

Перевести личный баланс на командный кошелек

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-in

Разрешения TRANSFER_BALANCE есть только у суперадминистраторов команды. Командный кошелек добавляется после атомарного списания личного пополнения баланса; переведенная сумма не включается в total_recharge_fee, и перевод обратно на личный баланс не поддерживается.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» amountbodynumber(double)trueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

Перевести баланс команды обратно в личный кабинет

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-out

Его можно вызвать только при входе в систему суперадминистратора. Атомные отчисления с кошелька команды и увеличение личного пополнения баланса; не меняйте совокупную сумму пополнения команды или отдельного лица. Расформированную команду можно использовать для восстановления баланса, но расформированную команду нельзя вызвать.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyTeamPublicIdtrueПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» amountbodynumber(double)trueНе должен превышать текущий доступный баланс команды.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKHTTP успешен; пожалуйста, продолжайте оценивать код тела ответаInline

Схема ответа

извлечение IP

Извлечь IP (GET /end-point/ip/get-ip)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-ip

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseКоманда Key может быть опущена; при передаче он должен соответствовать команде, к которой привязан Ключ.
app_keyquerystring(password)trueключ доступа
ccquerystringfalseСтрана или регион
statequerystringfalseпровинция или штат
cityquerystringfalseгород
formatquerystringfalseПолучить формат
lbquerystringfalseРазделитель, допустим только в текстовом формате.
numquerynumberfalseКоличество экстракта
lifequerynumberfalseПериод удержания - минуты
epquerystringfalseпрокси-сеть

Допустимые значения

ParameterValue
epus
ephk
epde

Примеры ответов

Ответ 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Запрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[any]falseнетnone

Список городов (GET /end-point/ip/dynamic-area-city-list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-area-city-list

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетсписок
»»» name_zh_cnstringfalseнетНазвание страны или региона
»»» name_enstringfalseнетНазвание страны или региона
»»» continent_codestringfalseнеткод континента
»»» country_codestringfalseнетКод страны или региона
»»» items[any]falseнетпровинция или штат
»»»» citystringfalseнетназвание города
»»»» statestringfalseнетКод названия провинции или штата
»»»» continent_codestringfalseнеткод континента
»»»» country_codestringfalseнетКод страны или региона

Статистика количества добычи IP по дням

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-extract-ip/days

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_datequerystring(date)falseПо умолчанию 6 дней назад
end_datequerystring(date)falseПо умолчанию сегодня
product_typequeryintegerfalseнет

Допустимые значения

ParameterValue
product_type9
product_type17
product_type22

Примеры ответов

Ответ 200

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетnone
» msgstringfalseнетnone
» request_idstringfalseнетnone
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» countintegertrueнетnone
»»» datestring(date)trueнетnone

Извлечь IP (GET /end-point/ip/v3)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseКоманда Key может быть опущена; при передаче он должен соответствовать команде, к которой привязан Ключ.
app_keyquerystring(password)trueключ доступа
ccquerystringfalseСтрана или регион
statequerystringfalseпровинция или штат
cityquerystringfalseгород
formatquerystringfalseПолучить формат
lbquerystringfalseРазделитель, допустим только в текстовом формате.
numquerynumberfalseКоличество экстракта
lifequerynumberfalseПериод удержания - минуты
epquerystringfalseпрокси-сеть

Допустимые значения

ParameterValue
epus
ephk
epde

Примеры ответов

Ответ 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Запрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[any]falseнетnone

Динамический региональный список городов V4

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

Получить список городов по имени пользователя, требуется аутентификация при входе, а учетная запись должна принадлежать текущему пользователю.

Параметры

ИмяРасположениеТипОбязательноОписание
usernamequerystringtrueИмя пользователя учетной записи агента

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» cachebooleanfalseнетНезависимо от того, исходит ли это из кеша
»» list[object]falseнетnone
»»» Citystringfalseнетгород
»»» Areastringfalseнетплощадь
»»» StatestringfalseнетШтат/Провинция

Динамический региональный список штатов/провинций V4

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

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

Параметры

ИмяРасположениеТипОбязательноОписание
usernamequerystringtrueИмя пользователя учетной записи агента

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» cachebooleanfalseнетНезависимо от того, исходит ли это из кеша
»» list[object]falseнетnone
»»» Citystringfalseнетгород
»»» Areastringfalseнетплощадь
»»» StatestringfalseнетШтат/Провинция

Динамический объединенный список региональных городов штатов и провинций V4

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

Получите объединенный список штатов/провинций и городов по имени пользователя, сгруппированный по регионам. Требуется аутентификация при входе, и учетная запись должна принадлежать текущему пользователю.

Параметры

ИмяРасположениеТипОбязательноОписание
usernamequerystringtrueИмя пользователя учетной записи агента

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» cachebooleanfalseнетНезависимо от того, исходит ли это из кеша
»» list[object]falseнетСписок областей
»»» Areastringfalseнеткод города
»»» states[object]falseнетСписок штатов/провинций
»»»» StatestringfalseнетНазвание штата/провинции
»»»» cities[string]falseнетСписок городов

Список городов (GET /end-point/ip/dynamic-citys)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/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": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетсписок
»»» name_zh_cnstringfalseнетНазвание страны или региона
»»» name_enstringfalseнетНазвание страны или региона
»»» continent_codestringfalseнеткод континента
»»» country_codestringfalseнетКод страны или региона
»»» items[any]falseнетпровинция или штат
»»»» citystringfalseнетназвание города
»»»» statestringfalseнетКод названия провинции или штата
»»»» continent_codestringfalseнеткод континента
»»»» country_codestringfalseнетКод страны или региона

Поиск города

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys/search

Параметры

ИмяРасположениеТипОбязательноОписание
country_codequerystringtrueКод страны или региона
statequerystringtrueКод штата или провинции

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[string]falseнетсписок

Государственный список

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/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": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетсписок
»»» name_zh_cnstringfalseнетНазвание страны или региона
»»» name_enstringfalseнетНазвание страны или региона
»»» continent_codestringfalseнеткод континента
»»» country_codestringfalseнетКод страны или региона
»»» items[any]falseнетпровинция или штат
»»»» statestringfalseнетКод названия провинции или штата
»»»» continent_codestringfalseнеткод континента
»»»» country_codestringfalseнетКод страны или региона

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

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states/search

Параметры

ИмяРасположениеТипОбязательноОписание
country_codequerystringtrueКод страны или региона

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[string]falseнетсписок

Получить список назначенных статических IP-адресов центра обработки данных.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/ip/get-datacenter-assign-ip-list

Устарело, рекомендуется использовать /openapi/user-product/datacenter-isp-ip-list. Чтобы быть совместимым со старыми клиентами, этот интерфейс использует метод POST, но все параметры фильтрации считываются из запроса.

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; опустите личное пространство или передайте пустую строку; Ключ команды можно опустить и он должен соответствовать ключу при передаче.
areaquerystringfalseКод страны
statusqueryintegerfalse0=все, 1=действительно, 2=истёк
trade_noquerystringfalseНомер заказа
created_atqueryarray[string]falseЧтобы создать временной диапазон, время начала и окончания должно быть передано одновременно.

Допустимые значения

ParameterValue
status0
status1
status2

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Извлечь приобретенный статический список IP-адресов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-static-ip

Параметры

ИмяРасположениеТипОбязательноОписание
country_codequerystringfalseКод страны или региона
product_typequerynumberfalseТип продукта, 25: Статический жилой IP-адрес, 14: IP-адрес центра обработки данных
trade_noquerystringfalseФильтровать IP по номеру заказа
pagequerynumberfalseНомер страницы
sizequerynumberfalseКоличество на странице
statusquerynumberfalseСтатус, 1: действителен, 2: недействителен, 3: срок действия истекает, 4: на обслуживании

Допустимые значения

ParameterValue
product_type14
product_type25
status1 - 2 - 3 - 4

Ответы

СтатусЗначениеОписаниеСхема

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

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

Параметры

ИмяРасположениеТипОбязательноОписание
ispqueryintegerfalseФильтрация интернет-провайдера, без фильтрации, если не передается (по умолчанию 1, кроме сайта 1/4/5)
asnqueryintegerfalseВозвращать ли пакетные данные ASN
exclusivequeryintegerfalseУчитывать ли по эксклюзивному инвентарю

Detailed descriptions

isp: Фильтрация интернет-провайдера, без фильтрации, если не передается (по умолчанию 1, кроме сайта 1/4/5)

ценностьописание
0Статический IP-адрес центра обработки данных (IDC)
1Домашний статический IP (ISP)

asn: Возвращать ли пакетные данные ASN

ценностьописание
0Не возвращать пакетные данные ASN (по умолчанию)
1Возврат данных пакета ASN

exclusive: Учитывать ли по эксклюзивному инвентарю

ценностьописание
0Статистика на основе текущего калибра пользователей/групп общего доступа (по умолчанию)
1Исключить все назначенные IP-адреса и считать только доступный инвентарь

Допустимые значения

ParameterValue
isp0
isp1
asn0
asn1
exclusive0
exclusive1

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успехов
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[any]falseнетnone
»»» codestringtrueнетКод страны или региона
»»» numberintegertrueнетКоличество

Получить поддерживаемые хостом страны/регионы

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

Запросите список стран/регионов, поддерживаемых текущим сайтом службы host_pool.

Этот интерфейс ориентирован на сценарий случайного извлечения IP-адресов центра обработки данных на основе точек трафика и подсчитывает страны/регионы только на основе инвентаризации IP-адресов центра обработки данных, доступной на текущем сайте.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успехов
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» codestringtrueнетКод страны или региона, ISO 3166-1 альфа-2.
»»» numberintegertrueнетКоличество IP-адресов центров обработки данных, доступных на текущем сайте
»»» name_zh_cnstringfalseнетНазвание страны или региона на китайском языке
»»» name_enstringfalseнетАнглийское название страны или региона
»»» square_flagstringfalseнетURL-адрес изображения квадратного флага

Белый список IP-адресов

Белый список IP-адресов (GET /end-point/proxy-ip/list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
product_typequeryintegerfalseНомер типа упаковки

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» ipstringfalseнетБелый список IP-адресов
»»» remarkstringfalseнетПримечания
»»» product_typeintegerfalseнетТип упаковки
»»» created_atstringfalseнетвремя создания

Добавить белый список IP-адресов (POST /end-point/proxy-ip/add)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» ipsbodystringtrueIP-адреса в белый список, которые необходимо добавить, разделяйте несколько запятыми или символами новой строки.
» remarkbodystringfalseПримечания
» product_typebodyintegerfalseНомер типа упаковки
» user_product_idbodyintegerfalseИдентификатор пользовательского пакета, требуется, если тип пакета равен 11.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Удалить белый список IP-адресов (POST /end-point/proxy-ip/delete)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» ipsbodystringtrueБелый список IP-адресов, которые необходимо удалить, несколько через запятую.
» verify_typebodystringfalseТип подтверждения: телефон, электронная почта, wechat, totp
» verify_codebodystringfalseКод подтверждения

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Белый список IP-адресов (GET /end-point/white-ip/list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
product_typequeryintegerfalseНомер типа упаковки

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» ipstringfalseнетБелый список IP-адресов
»»» remarkstringfalseнетПримечания
»»» product_typeintegerfalseнетТип упаковки
»»» created_atstringfalseнетвремя создания

Добавить белый список IP-адресов (POST /end-point/white-ip/add)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» ipsbodystringtrueIP-адреса в белый список, которые необходимо добавить, разделяйте несколько запятыми или символами новой строки.
» remarkbodystringfalseПримечания
» product_typebodyintegerfalseНомер типа упаковки
» user_product_idbodyintegerfalseИдентификатор пользовательского пакета, требуется, если тип пакета равен 11.

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Удалить белый список IP-адресов (POST /end-point/white-ip/delete)

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» app_keybodystringfalseКлюч авторизации
» ipsbodystringtrueБелый список IP-адресов, которые необходимо удалить, несколько через запятую.
» verify_typebodystringfalseТип подтверждения: телефон, электронная почта, wechat, totp
» verify_codebodystringfalseКод подтверждения

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успехов
» msgstringfalseнетсообщение о состоянии
» datanullfalseнетnone

Изменить примечания к белому списку IP-адресов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» ipbodystring(ipv4)trueнет
» remarkbodystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Обновить текущий кэш аутентификации белого списка IP-адресов ресурсного пространства.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Квота белого списка IP-адресов для определенных типов продуктов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quota

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
product_typequeryintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Квоты белого списка IP-адресов для всех типов продуктов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quotas

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

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

Недавно использованный трафик суммируется по дням

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» daysbodyintegerfalseнет
» product_typebodyintegerfalseнет
» usernamebodystringfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Историческое использование трафика учетной записи агента

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Экспортируйте ежемесячное использование трафика аккаунта агентства.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Примеры ответов

Ответ 200

Ответы

СтатусЗначениеОписаниеСхема
200OKCSV-файл в кодировке GBKstring

Общий объем и остаток пакетного трафика

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/flow-total

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
unitquerystringfalseнет

Допустимые значения

ParameterValue
unitKB
unitMB
unitGB
unitTB
unitPB

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
unitKB
unitMB
unitGB
unitTB
unitPB

График дневной ставки

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/rate-graph

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
startquerystring(date)falseнет
endquerystring(date)falseнет
usernamequerystringfalseнет
user_product_idqueryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Ежедневная статистика трафика кэша

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/cache-total

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_timequerystringfalseнет
end_timequerystringfalseнет
product_typequeryintegerfalseнет
usernamequerystringfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Использование трафика суммируется по дням

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/total

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
app_keyquerystring(password)trueКлюч аутентификации
start_timequerystring(Y-m-d H:i:s)falseВремя запуска с точностью до секунд. Обратите внимание, что регистрация задерживается в течение 5 минут. По умолчанию – в течение 7 дней.
end_timequerystring(Y-m-d H:i:s)falseСрок с точностью до секунд. Обратите внимание, что регистрация задерживается в течение 5 минут. Текущее время по умолчанию.
usernamequerystringfalseИмя суб-аккаунта, запрос всех аккаунтов по умолчанию, можно указать суб-аккаунт. Обратите внимание: если вы добавите дополнительную учетную запись с тем же именем, этот запрос вернет все записи об использовании учетной записи агента с тем же именем.
product_typequerynumberfalseТип упаковки

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» daystringfalseнетДата
»»» flowintegerfalseнетПотребление трафика, ед. КБ

Журнал агента

Статистика доступа к IP-прокси клиента

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/list-v2

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_timequerystring(date)falseнет
end_timequerystring(date)falseнет
exportquerystringfalseнет

Допустимые значения

ParameterValue
exportcsv

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKстатистические результаты JSON; CSV-файл возвращается, когда export=csvstring

Доля посещений клиентских IP-адресов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/client-ip-proportion

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
start_timequerystring(date)falseнет
end_timequerystring(date)falseнет
exportquerystringfalseнет

Допустимые значения

ParameterValue
exportcsv

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKРезультат пропорции JSON; CSV-файл возвращается, когда export=csvstring

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

Список купленных пакетов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
app_keyquerystring(password)trueКлюч аутентификации
trade_noquerystringfalseНомер заказа, пожалуйста, введите полный номер заказа. Нечеткий поиск не поддерживается.
pagequerynumberfalseПагинация, по умолчанию: 1
sizequerynumberfalseКоличество отображаемых страниц, по умолчанию: 20.
product_typequerynumberfalseТип упаковки

Примеры ответов

Ответ 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Запрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegertrueнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringtrueнетсообщение о состоянии
» dataobjectfalseнетnone
»» list[object]falseнетnone
»»» idintegerfalseнетНомер пакета
»»» created_atstringfalseнетСрок действия пакета
»»» expired_atstringfalseнетСрок годности пакета. По истечении срока использовать трафик невозможно.
»»» product_typeproductTypesfalseнетТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений
»»» trade_nostringfalseнетНомер транзакции заказа
»»» orderobjectfalseнетnone
»»»» created_atstringfalseнетВремя создания заказа
»»»» pay_atstringfalseнетСрок оплаты заказа
»»»» titlestringfalseнетОписание заказа
»» pageintegertrueнетТекущая страница
»» page_sizeintegerfalseнетразмер страницы
»» total_countintegerfalseнетОбщее количество записей
»» total_pageintegerfalseнетОбщее количество страниц

Допустимые значения

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

Сводка данных пользовательского пакета

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

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

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
app_keyquerystring(password)trueКлюч аутентификации
product_typequeryintegerfalseТип продукта, поддерживает только 9 (пакет динамического трафика), 12 (пакет долгосрочного трафика IDC)

Допустимые значения

ParameterValue
product_type9
product_type12

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Status Code 200

ИмяТипОбязательноОграниченияОписание
» codeintegerfalseнетКод состояния, 200 успешно, 3 app_key недействителен, 156 учетная запись не аутентифицирована.
» msgstringfalseнетсообщение о состоянии
» dataobjectfalseнетnone
»» totalintegerfalseнетТрафик/общий объем IP (единица измерения: КБ)
»» total_countintegerfalseнетОбщее количество упаковок
»» effectiveintegerfalseнетЭффективная оставшаяся сумма (единица измерения: КБ)
»» effective_countintegerfalseнетКоличество действительных пакетов
»» effective_totalintegerfalseнетЭффективная общая сумма (единица измерения: КБ)
»» effective_usedintegerfalseнетИспользуемая эффективная сумма (единица измерения: КБ)
»» temporaryintegerfalseнетОбщая сумма к оплате (к оплате в течение 7 дней, единица измерения: КБ)
»» temporary_countintegerfalseнетКоличество пакетов с истекающим сроком действия (срок действия – 7 дней)
»» expiredintegerfalseнетОставшаяся сумма с истекшим сроком действия (единица измерения: КБ)
»» expired_countintegerfalseнетКоличество просроченных упаковок
»» usedintegerfalseнетОбщий использованный объем (единица измерения: КБ)

Статический список IP-адресов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» statusbodyintegerfalseнет
» pagebodyintegerfalseнет
» sizebodyintegerfalseнет
» user_product_idbodyintegerfalseнет
» country_codebodystringfalseнет
» product_typebodyintegerfalseнет
» ipbodystring(ipv4)falseнет
» auto_renewalbodyintegerfalseнет
» support_renewalbodyintegerfalseнет
» remaining_daysbodyintegerfalseнет
» limit_daysbodyintegerfalseнет
» sortbodystringfalseнет
» remarkbodystringfalseнет

Допустимые значения

ParameterValue
» auto_renewal0
» auto_renewal1
» support_renewal0
» support_renewal1
» sortexp_asc
» sortexp_desc

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Удалить просроченные пакеты

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Удаление пакетов с истекшим сроком действия в пакетном режиме

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idsbody[integer]trueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Изменить примечания к пакету

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueнет
» remarkbodystringtrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Пакетная установка статических IP-переключателей UDP.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idsbody[integer]trueнет
» udpbodyintegertrueнет

Допустимые значения

ParameterValue
» udp0
» udp1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

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

Изменить статический IP-адрес интернет-провайдера центра обработки данных

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» idbodyintegertrueИдентификатор пользовательского плана
» country_codebodystringfalseКод целевой страны/региона; если не указано, то в первую очередь будет использоваться текущая страна/регион IP.
» ipbodystringfalseФильтрация префикса IP-адреса назначения

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

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

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/ip-change-log

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseИдентификатор ресурсного пространства; личное пространство опустить или передать пустую строку
pagequeryintegerfalseнет
page_sizequeryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Установите переключатель автоматического продления для одного пакета.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idbodyintegertrueнет
» statusbodyintegerfalse0=отключить, 1=включить

Допустимые значения

ParameterValue
» status0
» status1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Установите переключатель автоматического продления для пакетов в пакетном режиме.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idsbody[integer]trueнет
» statusbodyintegerfalse0=отключить, 1=включить

Допустимые значения

ParameterValue
» status0
» status1

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешен; каждый пакет независимо возвращает результаты обработки.Inline

Схема ответа

Установите параметры автоматического продления по умолчанию для типов продуктов

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal-default-config

Пропустите хотя бы один из дней_до_истечения, трафика_порога, продления_цикла_дней; значение 0 означает сброс соответствующей конфигурации.

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» product_typebodyintegertrueнет
» days_before_expirebodyintegerfalseнет
» traffic_thresholdbodyintegerfalseЕдиницы ГБ, поддерживается только 12.09.24.
» renewal_cycle_daysbodyintegerfalseПоддерживается только 14.11.16.25 и должен соответствовать текущему циклу продаж продукта.
» anonymousbodyobjectfalseнет
» anonymousbodyobjectfalseнет
» anonymousbodyobjectfalseнет

Допустимые значения

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешен, данные пустыеInline

Схема ответа

Получите параметры автоматического продления по умолчанию для типа продукта.

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» product_typebodyintegerfalseЕсли не передать, будут возвращены все поддерживаемые типы.

Допустимые значения

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
product_type9
product_type11
product_type12
product_type14
product_type16
product_type24
product_type25
sourceuser
sourcesystem
sourceuser
sourcesystem
traffic_sourceuser
traffic_sourcesystem

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

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idbodyintegertrueнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
time_unitday
time_unithour
status0
status1

Получайте записи выполнения автоматического продления

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjectfalseнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» user_product_idbodyintegerfalseЕсли не передать, будут запрошены все записи в текущем пространстве.
» pagebodyintegerfalseнет
» sizebodyintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Допустимые значения

СвойствоЗначение
trigger_type0
trigger_type1
status1
status2
status3

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

Поднять оплату заказа

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
trade_noquerystringtrueнет
pm_idqueryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Инициировать оплату неоплаченных заказов, оформленных в фоновом режиме

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

Параметры

ИмяРасположениеТипОбязательноОписание
bodybodyobjecttrueнет
» team_idbodyanyfalseИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
»» anonymousbodystringfalseнет
»» anonymousbodyTeamPublicIdfalseПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
» trade_nobodystringtrueнет
» pay_methodbodyintegerfalseнет
» pm_idbodyintegerfalseнет
» trade_typebodystringfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKОперация прошла успешноWebV1SuccessResponse

Предварительный просмотр комиссии за контрольную сумму оплаты

Примеры кода

# Также можно использовать wget
curl -X POST https://api.proxylite.com/end-point/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/pay-check

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
trade_noquerystringtrueнет
pm_idqueryintegerfalseнет

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKЗапрос успешенInline

Схема ответа

Непосредственно отображать страницу веб-платежей

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/pay/web-direct-pay

Параметры

ИмяРасположениеТипОбязательноОписание
team_idqueryResourceSpaceIdfalseнет
trade_noquerystringtrueнет
pm_idqueryintegerfalseнет

Примеры ответов

Ответ 200

"string"

Ответы

СтатусЗначениеОписаниеСхема
200OKHTML-страница оплатыstring

Получить список способов оплаты (GET /end-point/payment/list)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/list

Параметры

ИмяРасположениеТипОбязательноОписание
trade_noquerystringfalseНомер заказа — можно передать, если для некоторых заказов требуется определенный способ оплаты.
currencyquerystringfalseденежная единица

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKдобиться успехаInline

Схема ответа

Получить список способов оплаты (GET /end-point/payment/groups)

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

Параметры

ИмяРасположениеТипОбязательноОписание
trade_noquerystringfalseНомер заказа — можно передать, если для некоторых заказов требуется определенный способ оплаты.

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKдобиться успехаInline

Схема ответа

Маркетинг

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

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/activity/balance-recharge-gift-ratio

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

Примеры ответов

Ответ 200

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

Ответы

СтатусЗначениеОписаниеСхема
200OKOKInline

Схема ответа

Продукты

Список продуктов

Примеры кода

# Также можно использовать wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

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

Параметры

ИмяРасположениеТипОбязательноОписание
typequeryintegerfalseТип упаковки см. в описании перечисления Product.type. Если не передать, будут возвращены все типы.
parent_product_typequeryintegerfalseТип родительского пакета, действителен только при типе = 19 (продление IP-адреса), используется для фильтрации линеек продуктов: 14 = центр обработки данных 25 = жилой дом.
time_daysqueryanyfalseФильтрация периода действия, поддерживает одно значение или массив, например 30 / [30,90,365]
show_typequeryanyfalseФильтрация типов отображения, поддерживает одно значение или массив.

Допустимые значения

ParameterValue
parent_product_type14
parent_product_type25

Примеры ответов

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

Ответы

СтатусЗначениеОписаниеСхема
200OKOKInline

Схема ответа

Схемы

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетИдентификатор пользователя
usernamestringtrueнетИмя пользователя
nicknamestringtrueнетПсевдоним
emailstringtrueнетПривязать электронную почту
balancestringtrueнетБаланс пополнения, десятичная строка
gift_balancestringtrueнетТекущий бонусный баланс, десятичная строка
currencystringtrueнетВалюта сайта
languagestringtrueнетЯзык пользователя, язык сайта используется, если не настроен
timezonestringtrueнетЧасовой пояс пользователя, используйте часовой пояс сайта, если не настроено

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
re_typeinteger,stringfalseнет0 расходов, 1 доходов
transaction_typeinteger,stringfalseнеттип транзакции
balance_typeinteger,stringfalseнетТип баланса
feestring,numberfalseнетИзменить сумму, валюту сайта

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
user_idinteger,stringfalseнетДетальный интерфейс возвращает
start_timestringfalseнетГ-м-д Ч:и:с; дата, отличная от RFC 3339
end_timestringfalseнетГ-м-д Ч:и:с; дата, отличная от RFC 3339
statusstringfalseнетnone
file_sizeinteger,string,nullfalseнетnone
record_countinteger,string,nullfalseнетnone
created_atstringfalseнетГ-м-д Ч:и:с; дата, отличная от RFC 3339
completed_atstringfalseнетГ-м-д Ч:и:с; дата, отличная от RFC 3339
file_urlstringfalseнетПосле завершения возвращается подробный интерфейс.
download_urlstringfalseнетВозврат после завершения, адрес загрузки подписи действителен в течение 24 часов.
error_messagestringfalseнетВ случае сбоя интерфейс сведений может вернуться

Допустимые значения

СвойствоЗначение
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

Свойства

ИмяТипОбязательноОграниченияОписание
idinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
coupon_idinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
typeinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
statusinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
sourceinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
titlestringfalseнетnone
title_enstringfalseнетnone
descriptionstringfalseнетnone
description_enstringfalseнетnone
start_amountstring,number,nullfalseнетnone
start_amount_usdstring,number,nullfalseнетnone
start_amount_hkdstring,number,nullfalseнетnone
deduction_amountstring,number,nullfalseнетnone
deduction_amount_usdstring,number,nullfalseнетnone
deduction_amount_hkdstring,number,nullfalseнетnone
discount_ratestring,number,nullfalseнетnone
discount_ceiling_amountstring,number,nullfalseнетnone
discount_ceiling_amount_usdstring,number,nullfalseнетnone
discount_ceiling_amount_hkdstring,number,nullfalseнетnone
created_atstring,nullfalseнетY-m-d H:i:s
effect_atstring,nullfalseнетY-m-d H:i:s
expired_atstring,nullfalseнетY-m-d H:i:s
used_atstring,nullfalseнетY-m-d H:i:s
product_typesstring,nullfalseнетПрименимые типы пакетов
created_timestampinteger,nullfalseнетnone
effect_timestampinteger,nullfalseнетnone
expired_timestampinteger,nullfalseнетnone
used_timestampinteger,nullfalseнетnone
is_expiredbooleanfalseнетВозвращает интерфейс списка

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

Свойства

ИмяТипОбязательноОграниченияОписание
idinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
titlestringfalseнетnone
contentstringfalseнетКонтент отображается на запрошенном языке
typeinteger,stringfalseнетЗначения базы данных могут быть сериализованы как строки.
read_statusintegerfalseнетnone
created_atstringfalseнетГ-м-д Ч:и:с; дата, отличная от RFC 3339
created_timestampintegerfalseнетnone

Допустимые значения

СвойствоЗначение
read_status0
read_status1

productTypes

9

Тип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений

Свойства

ИмяТипОбязательноОграниченияОписание
anonymousintegerfalseнетТип пакета, 9 пакетов динамического трафика для жилых помещений, 11 динамических IP для жилых помещений, 14 статических IP-адресов для центров обработки данных, 25 статических IP-адресов для жилых помещений

Допустимые значения

СвойствоЗначение
anonymous9
anonymous11
anonymous14
anonymous25

apiKey

"pa$$word"

API-ключ; передается с использованием apiKeyAuth или параметра запроса, объявленного операцией

Свойства

ИмяТипОбязательноОграниченияОписание
anonymousstring(password)falseнетAPI-ключ; передается с использованием apiKeyAuth или параметра запроса, объявленного операцией

responseCode

200

Код состояния, 200 успешно, 3 app_key недействительны

Свойства

ИмяТипОбязательноОграниченияОписание
anonymousintegerfalseнетКод состояния, 200 успешно, 3 app_key недействительны

responseMsg

"success"

response message

Свойства

ИмяТипОбязательноОграниченияОписание
anonymousstringfalseнетresponse message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Свойства

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Свойства

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
codeintegertrueнетnone
msgstringtrueнетnone
dataobject,array,string,number,boolean,nulltrueнетБизнес-данные, конкретный тип определяется интерфейсом
request_idstringtrueнетЗапросить идентификатор отслеживания ссылки

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
codeintegertrueнетКод бизнес-ошибки

not

ИмяТипОбязательноОграниченияОписание
» anonymousanyfalseнетnone

continued

ИмяТипОбязательноОграниченияОписание
msgstringtrueнетОписание ошибки
dataobject,array,nulltrueнетОшибка дополнительных данных, ноль, если дополнительных данных нет.
request_idstringtrueнетЗапросить идентификатор отслеживания ссылки

TeamPublicId

"A1b2C3d4E5f6"

Публичный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Свойства

ИмяТипОбязательноОграниченияОписание
anonymousstringfalseнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

ResourceSpaceId

"A1b2C3d4E5f6"

Идентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.

Свойства

oneOf

ИмяТипОбязательноОграниченияОписание
anonymousstringfalseнетnone

xor

ИмяТипОбязательноОграниченияОписание
anonymousTeamPublicIdfalseнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
namestringtrueнетНазвание команды
super_admin_user_idintegertrueнетИдентификатор пользователя суперадминистратора
statusintegertrueнетСтатус команды: 0=отключена, 1=действительна, 2=расформирована, 3=расформирована.
current_roleinteger,nulltrueнетРоль текущего пользователя в команде; ноль, если невозможно определить
dissolving_atstring,nulltrueнетНачало времени растворения
dissolved_atstring,nulltrueнетВремя завершения растворения
created_atstringtrueнетвремя создания
updated_atstringtrueнетВремя обновления

Допустимые значения

СвойствоЗначение
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетИдентификатор пользовательского плана
user_idintegertrueнетИдентификатор пользователя владельца ресурса
team_idResourceSpaceIdtrueнетИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
team_user_idintegertrueнетФактическое создание идентификаторов пользователей-участников
product_idintegertrueнетИдентификатор продукта
product_typeintegertrueнеттип продукта
parent_product_typeintegertrueнетРодительский тип продукта
statusintegertrueнетСтатус пакета
total_amountinteger(int64)trueнетобщая сумма
remaininteger(int64)trueнетОставшаяся сумма
bandwidthintegerfalseнетПропускная способность (Мбит/с); возвращается только по Product_type=19 или 11
concurrencyintegerfalseнетКоличество параллелизма; возвращается только product_type=11
expired_atstring,nulltrueнетСрок годности
created_atstringtrueнетвремя создания
ipstringfalseнетСтатический IP-адрес; возвращается только product_type=19
country_codestringfalseнетСтатический IP-код страны; возвращается только product_type=19
country_namestringfalseнетСтатический IP-адрес страны; возвращается только по product_type=19
asnstringfalseнетСтатический IP-адрес ASN; возвращается только product_type=19
portintegerfalseнетСтатический IP-порт прокси-сервера; возвращается только по product_type=19

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

Статистические поля пакета соответствуют /web_v1/user/info; записи об отмене, возврате или мягком удалении не включаются в сводку; кроме team_id и Product_types, возвращаются только поля, соответствующие типам продуктов, поддерживаемым текущим сайтом.

Свойства

ИмяТипОбязательноОграниченияОписание
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
product_types[integer]trueнетПространство ресурсов группы не было отменено или обратимо удалено, а тип пакета поддерживается текущим сайтом.
product_residence_remain_countinteger(int64)falseнетОстаточный расход типа 9
product_residence_total_countinteger(int64)falseнетОбщий трафик типа 9
pdrue2_timestampinteger(int64)falseнетВведите 11 последнюю метку времени истечения срока действия; 0, когда нет командного пакета
remaininteger,stringfalseнетТип 17 Оставшееся количество
total_amountinteger,stringfalseнетТип 17 Общее количество
scraping_remaininteger(int64)falseнетВведите 18 оставшихся раз
scraping_total_amountinteger(int64)falseнетВведите 18 раз
scraping_timestampstringfalseнетВведите 18 последний срок годности; «-» когда пакета нет
scraping_timestamp2integer(int64)falseнетВведите 18 последнюю дату истечения срока действия.
common_scraping_remaininteger(int64)falseнетВведите 29 оставшихся раз
common_scraping_total_amountinteger(int64)falseнетВведите 29 Общее количество раз
common_scraping_timestampstringfalseнетВведите 29 последний срок годности; «-» когда пакета нет
common_scraping_timestamp2integer(int64)falseнетВведите 29 последнюю дату истечения срока действия.
pdidcr_countintegerfalseнетТип 12 Действительное количество упаковки
pdidcr_totalintegerfalseнетОбщее количество упаковок типа 12
pdidcr_traffic_remaininteger(int64)falseнетТип 12 Остаточный поток
pdidcr_traffic_totalinteger(int64)falseнетОбщий трафик типа 12
p_sitai_ip_countintegerfalseнетВведите 13 действительный IP-номер
p_sitai_ipintegerfalseнетТип 13 Допустимое количество упаковки
p_sitai_ip_totalintegerfalseнетОбщее количество упаковок типа 13
p_sitai_remaininteger(int64)falseнетОстаточный поток Тип 13/24
p_sitai_totalinteger(int64)falseнетТип 13/24 Общий расход
pdidc_countintegerfalseнетТип 14 Допустимое количество упаковки
pdidc_totalintegerfalseнетОбщее количество упаковок типа 14
pdidc_ip_countintegerfalseнетВведите 14 действительный IP-номер
pdidc_ip_all_countintegerfalseнетТип 14 IP Всего
pdispr_countintegerfalseнетТип 15 Допустимое количество упаковки
pdispr_totalintegerfalseнетОбщее количество упаковок типа 15
pdispr_traffic_remaininteger(int64)falseнетОстаточный поток Тип 15
pdispr_traffic_totalinteger(int64)falseнетТип 15 Общий трафик
product_datacenter_isp_traffic_ip_countintegerfalseнетВведите 16 действительный IP-номер
product_datacenter_isp_traffc_ipintegerfalseнетТип 16. Допустимое количество упаковки; Исторически совместимое написание
product_datacenter_isp_traffc_ip_totalintegerfalseнетВсего упаковок типа 16; Исторически совместимые написания
product_datacenter_isp_traffic_ipintegerfalseнетТип 16 Допустимое количество упаковки
product_datacenter_isp_traffic_ip_totalintegerfalseнетОбщее количество упаковок типа 16
product_datacenter_isp_traffc_remaininteger(int64)falseнетОстаточный трафик типа 16/24; исторически совместимое написание
product_datacenter_isp_traffc_totalinteger(int64)falseнетОбщий расход Тип 16/24; исторически совместимое написание
product_datacenter_isp_traffic_remaininteger(int64)falseнетОстаточный поток Тип 16/24
product_datacenter_isp_traffic_totalinteger(int64)falseнетТип 16/24 Общий расход
product_datacenter_isp_ipintegerfalseнетВведите 21 или 25 допустимое количество упаковки.
product_datacenter_isp_ip_totalintegerfalseнетВсего введите 21 или 25 упаковок.
product_datacenter_isp_ip_countintegerfalseнетВведите 21 или 25 действительный IP-номер
product_datacenter_isp_ip_all_countintegerfalseнетВсего тип 21 или 25 IP
product_datacenter_isp_ip_traffic_remaininteger(int64)falseнетТип 21 соответствует остаточному расходу типа 24.
product_datacenter_isp_ip_traffic_totalinteger(int64)falseнетТип 21 соответствует общему расходу типа 24.
product_agent_residence_remain_countinteger(int64)falseнетТип 22 Остаточный поток
product_agent_residence_total_countinteger(int64)falseнетТип 22 Общий трафик
product_serp_remaininteger(int64)falseнетВведите 27 оставшихся раз
product_serp_totalinteger(int64)falseнетВведите 27 «Общее время»
product_serp_timestampstringfalseнетВведите 27 последний срок годности; «-» когда пакета нет
product_serp_timestamp2integer(int64)falseнетВведите 27 последнюю дату истечения срока действия.
product_video_remaininteger(int64)falseнетТип 28 Остаточный поток
product_video_totalinteger(int64)falseнетТип 28 Общий расход
product_video_timestampstringfalseнетВведите 28 последний срок годности; «-» когда пакета нет
product_video_timestamp2integer(int64)falseнетВведите 28 последнюю дату истечения срока действия.

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

Командный кошелек, изолированный от личного баланса суперадминистратора; для суммы используется валюта текущего сайта по умолчанию с точностью до 4 знаков после запятой.

Свойства

ИмяТипОбязательноОграниченияОписание
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
balancenumber(double)trueнетТекущий доступный баланс команды
total_recharge_feenumber(double)trueнетТекущая неизрасходованная сумма пополнения баланса команды, за исключением суммы перевода с личного баланса.
updated_atstringtrueнетВремя последнего изменения кошелька

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетnone
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
operator_user_idintegertrueнетОператор, системный возврат 0
creatorTeamCreatorfalseнетnone
directionintegertrueнет0=расход, 1=доход
transaction_typeintegertrueнет1=Пополнение на счет, 2=Перевод с личного баланса, 3=Использование баланса, 4=Возврат или возврат пополнения, 5=Перевод обратно на личный баланс
amountnumber(double)trueнетВеличина этого изменения, направление представлено направлением
after_balancenumber(double)trueнетБаланс командного кошелька после изменения
link_idintegertrueнетИдентификатор связанного заказа; при передаче личного баланса это идентификатор действующего пользователя
request_idstringtrueнетnone
remarkstringtrueнетnone
created_atstringtrueнетnone

Допустимые значения

СвойствоЗначение
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
user_idintegertrueнетИдентификатор пользователя оператора; работа системы равна 0
display_namestringtrueнетОтображаемое имя, псевдоним, имя пользователя, адрес электронной почты и номер мобильного телефона по порядку.
nicknamestringtrueнетnone
usernamestringtrueнетnone
emailstringtrueнетНеадминистраторская точка зрения – это ценность снижения чувствительности
phonestringtrueнетНеадминистраторская точка зрения – это ценность снижения чувствительности

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamfalseнетnone

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[Team]trueнетnone
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» page_sizeintegertrueнетnone

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[TeamMember]trueнетnone
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» page_sizeintegertrueнетnone

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[TeamPerson]trueнетnone
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» page_sizeintegertrueнетnone

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamAssetfalseнетnone

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamProductInfofalseнетСтатистические поля пакета соответствуют /web_v1/user/info; записи об отмене, возврате или мягком удалении не включаются в сводку; кроме team_id и Product_types, возвращаются только поля, соответствующие типам продуктов, поддерживаемым текущим сайтом.

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamWalletfalseнетКомандный кошелек, изолированный от личного баланса суперадминистратора; для суммы используется валюта текущего сайта по умолчанию с точностью до 4 знаков после запятой.

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[TeamWalletRecord]trueнетnone
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» page_sizeintegertrueнетnone

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[TeamAsset]trueнетnone
»» totalintegertrueнетnone
»» pageintegertrueнетnone
»» page_sizeintegertrueнетnone

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетAPI Key ID
api_keystringtrueнетОтвет создания – это полный Ключ; список команд — это замаскированное значение
team_user_idintegertrueнетКлюч группы фактически содержит идентификатор участника, а личный ключ равен 0.
remarkstringtrueнетПримечания
statusintegertrueнет0=отключить, 1=включить
created_atstringtrueнетвремя создания
updated_atstring,nullfalseнетВремя обновления

Допустимые значения

СвойствоЗначение
status0
status1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

Свойства

ИмяТипОбязательноОграниченияОписание
invoice_codestringfalseнетnone
namestringfalseнетnone
org_namestringfalseнетnone
first_namestringfalseнетnone
last_namestringfalseнетnone
phonestringfalseнетnone
emailstring(email)falseнетnone
role_typeintegerfalseнетnone
invoice_typeintegerfalseнетnone
vat_idstringfalseнетnone
tax_nostringfalseнетnone
address_countrystringfalseнетnone
address_citystringfalseнетnone
address_line1stringfalseнетnone
address_line2stringfalseнетnone
address_postal_codestringfalseнетnone
bank_namestringfalseнетnone
bank_accountstringfalseнетnone
is_defbooleanfalseнетnone

Допустимые значения

СвойствоЗначение
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
team_idResourceSpaceIdfalseнетИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
user_product_idsanytrueнетМассив идентификаторов пользовательского плана, также совместимый с английскими строками, разделенными запятыми.

oneOf

ИмяТипОбязательноОграниченияОписание
» anonymous[integer]falseнетnone

xor

ИмяТипОбязательноОграниченияОписание
» anonymousstringfalseнетnone

continued

ИмяТипОбязательноОграниченияОписание
user_coupon_idintegerfalseнетnone
coupon_snstringfalseнетnone

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетИдентификатор приглашения
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
inviter_user_idintegertrueнетИдентификатор приглашающего пользователя
invitee_user_idintegertrueнетИдентификатор приглашенного пользователя, 0, если ни один зарегистрированный пользователь еще не сопоставлен.
invite_typeintegertrueнетТип приглашения: 1=зарегистрированный пользователь, 2=электронная почта, 3=номер мобильного телефона.
invite_country_codeintegertrueнетКод страны или региона номера мобильного телефона, 0 для приглашений без номера мобильного телефона.
invite_targetstringtrueнетСтандартизированная цель приглашения; зарегистрированный пользователь — user:{user_id}
delivery_typeintegertrueнетИсходный канал доставки: 1=зарегистрированный пользователь, 2=электронная почта, 3=номер мобильного телефона; исходный канал будет сохранен, если адрес электронной почты или номер мобильного телефона соответствует зарегистрированному пользователю.
roleintegertrueнетЦелевая роль: 2=администратор, 3=обычный участник.
statusintegertrueнетСтатус приглашения: 0 = в ожидании, 1 = принято, 2 = отклонено, 3 = отменено, 4 = срок действия истек.
accepted_by_user_idintegertrueнетИдентификатор пользователя-принимателя, 0, если не принято
expired_atstringtrueнетСрок годности в формате ГГГГ-ММ-ДД ЧЧ:мм:сс
accepted_atstring,nulltrueнетВремя приема
rejected_atstring,nulltrueнетвремя отклонения
cancelled_atstring,nulltrueнетВремя отмены
created_atstringtrueнетВремя создания, формат ГГГГ-ММ-ДД ЧЧ:мм:сс

Допустимые значения

СвойствоЗначение
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
team_member_idintegertrueнетИдентификатор членства
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
user_idintegertrueнетИдентификатор пользователя участника
roleintegertrueнетРоль: 1=суперадминистратор, 2=администратор, 3=обычный член, 4=финансовый член.
statusintegertrueнетСтатус участника: 0=отключен, 1=действителен, 2=вышел, 3=удален.
joined_atstring,nulltrueнетВремя присоединения, формат ГГГГ-ММ-ДД ЧЧ:мм:сс
nicknamestringtrueнетНикнейм участника
usernamestringtrueнетИмя пользователя участника

Допустимые значения

СвойствоЗначение
role1
role2
role3
role4
status0
status1
status2
status3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
record_typestringtrueнетТип записи; участник является действительным участником, приглашение находится на рассмотрении
record_idintegertrueнетИдентификатор участника или идентификатор приглашения
team_idTeamPublicIdtrueнетПубличный логотип команды, первый символ — буква ASCII, остальные символы содержат только буквы и цифры ASCII; числовой первичный ключ базы данных не выдан
user_idintegertrueнетИдентификатор пользователя, незарегистрированные приглашенные пользователи — 0.
inviter_user_idintegertrueнетИдентификатор приглашающего пользователя, запись участника – 0.
invite_typeintegertrueнетТип приглашения, запись участника – 0.
invite_country_codeintegertrueнетКод страны или города номера мобильного телефона, запись участника – 0.
invite_targetstringtrueнетЦель приглашения, запись участника — пустая строка.
delivery_typeintegertrueнетИсходный канал доставки, запись участника – 0.
roleintegertrueнетРоль: 1=суперадминистратор, 2=администратор, 3=обычный член, 4=финансовый член.
statusintegertrueнетчлену присвоено значение 1, приглашению присвоено значение 0
display_namestringtrueнетОтображайте имя единообразно, упорядочивая псевдоним, имя пользователя, адрес электронной почты и номер мобильного телефона; используйте десенсибилизированные значения для контактной информации с точки зрения обычных участников
nicknamestringtrueнетНикнейм участника или зарегистрированного приглашенного пользователя
usernamestringtrueнетУчастник или зарегистрированное приглашенное имя пользователя
emailstringtrueнетэлектронная почта; суперадминистраторы и администраторы возвращают полные значения, обычные участники возвращают значения снижения чувствительности со звездочками
phonestringtrueнетНомер мобильного телефона; суперадминистраторы и администраторы возвращают полное значение, а обычные участники возвращают десенсибилизированное значение со звездочкой.
joined_atstring,nulltrueнетВремя присоединения участника, запись о приглашении пуста
expired_atstring,nulltrueнетСрок действия приглашения истек, запись участника пуста
created_atstringtrueнетВремя создания записи в формате ГГГГ-ММ-ДД ЧЧ:мм:сс

Допустимые значения

СвойствоЗначение
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamInvitationfalseнетnone

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataTeamMemberfalseнетnone

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» invitationTeamInvitationtrueнетnone
»» invitation_tokenstringtrueнетТокен приглашения в виде открытого текста, зарезервированный только для совместимых существующих клиентов; новые клиенты используют ignore_url напрямую
»» invitation_urlstring(uri)trueнетСсылка на внешнюю обработку, содержащая токен приглашения
»» notification_channelsTeamInvitationNotificationChannelstrueнетnone

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

Свойства

ИмяТипОбязательноОграниченияОписание
emailstringfalseнетРезультаты канала электронной почты
smsstringfalseнетРезультаты смс-канала
site_inner_messagestringfalseнетРезультаты канала сообщений сайта

Допустимые значения

СвойствоЗначение
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» team_namestringtrueнетНазвание команды
»» roleintegertrueнетцелевая роль
»» statusintegertrueнетстатус приглашения
»» expired_atstringtrueнетСрок годности в формате ГГГГ-ММ-ДД ЧЧ:мм:сс

Допустимые значения

СвойствоЗначение
role2
role3
status0
status1
status2
status3
status4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» invitationTeamInvitationtrueнетnone
»» invitation_urlstring(uri)trueнетНовая ссылка для обработки приглашений; старая ссылка больше не работает
»» notification_channelsTeamInvitationNotificationChannelstrueнетnone

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

Свойства

allOf

ИмяТипОбязательноОграниченияОписание
anonymousWebV1SuccessResponsefalseнетnone

and

ИмяТипОбязательноОграниченияОписание
anonymousobjectfalseнетnone
» dataobjectfalseнетnone
»» list[TeamInvitation]trueнетnone
»» totalintegertrueнетобщее количество приглашений
»» pageintegertrueнетТекущий номер страницы
»» page_sizeintegertrueнетфактическое количество на странице

User

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

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
emailstring(email)falseнетnone
phonestringfalseнетnone
balancenumber(float)falseнетnone
statusintegerfalseнетnone
is_real_namebooleanfalseнетnone
created_atstring(date-time)falseнетnone

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетИдентификатор заказа
trade_nostringfalseнетВнутренний номер заказа
out_trade_nostringfalseнетВнешний номер заказа
product_idintegerfalseнетИдентификатор пакета
product_typeintegerfalseнетТип упаковки, см. перечисление типов продуктов.
amountintegerfalseнетКоличество покупки
unit_pricenumber(float)falseнетцена за единицу
total_feenumber(float)falseнетОбщая стоимость заказа (без учета скидок и комиссий за обработку)
goods_feenumber(float)falseнетЦена продукта (включая скидки, без учета комиссий за обработку)
pay_feenumber(float)falseнетФактическая уплаченная сумма (включая скидки и комиссию за обработку)
discount_feenumber(float)falseнетСумма скидки
handling_feenumber(float)falseнетплата за обработку
refund_feenumber(float)falseнетСумма возврата
pm_idintegerfalseнетИдентификатор способа оплаты (из /openapi/payation/list)
pm_titlestringfalseнетНазвание способа оплаты
pm_logostringfalseнетСпособ оплаты URL-адрес логотипа
statusintegerfalseнетСтатус заказа
titlestringfalseнетНазвание пакета
detailstringfalseнетОписание пакета
region_descstringfalseнетОписание спецификации региона
pay_atstring(date-time)falseнетвремя оплаты
pay_timestampintegerfalseнетВременная метка платежа
created_atstring(date-time)falseнетвремя создания
pay_fee_statusintegerfalseнетСтатус длинного и короткого платежа: 0 обычный 1 длинный платеж (переплата) 2 короткий платеж
invoiceobjectfalseнетИнформация о счете (ценна только для онлайн-платежных заказов)
» namestringfalseнетполное имя
» org_namestringfalseнетНазвание компании
» first_namestringfalseнетnone
» last_namestringfalseнетnone
» phonestringfalseнетnone
» emailstring(email)falseнетnone
» role_typeintegerfalseнет1 человек 2 компании
» vat_idstringfalseнетИдентификационный номер налогоплательщика
» address_countrystringfalseнетnone
» address_citystringfalseнетnone
» address_line1stringfalseнетnone
» address_line2stringfalseнетnone
» address_postal_codestringfalseнетnone

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

Заказать результаты предварительной проверки

Свойства

ИмяТипОбязательноОграниченияОписание
product_idintegerfalseнетИдентификатор пакета
amountintegerfalseнетКоличество
discount_feenumber(float)falseнетСумма скидки
total_feenumber(float)falseнетОбщая сумма заказа
pay_feenumber(float)falseнетФактическая выплаченная сумма
product_typeintegerfalseнетТип упаковки
titlestringfalseнетНазвание пакета
detailstringfalseнетОписание пакета
ip_result[object]falseнетРезультаты пакетного продления IP (возвращаются только во время продления IP)
» ipstringfalseнетnone
» pricenumber(float)falseнетnone
» country_codestringfalseнетnone
» current_timestring(date-time)falseнетnone
» renewal_timestring(date-time)falseнетnone
» countryobjectfalseнетnone
»» name_zh_cnstringfalseнетnone
»» flagstringfalseнетURL-адрес кругового флага
»» square_flagstringfalseнетURL-адрес квадратного флага

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетИдентификатор пакета
titlestringfalseнетОсновное название пакета
typeintegerfalseнетТип упаковки
show_typeintegerfalseнетТип дисплея: 1 Обычный 2 Большая рекомендация 3 Не доступен для покупки (требуется настройка) 4 Пробная версия
statusintegerfalseнетСтатус: 1 на полках 0 нет на полках
pricenumber(float)falseнетЦена в юанях
usd_pricenumber(float)falseнетцена в долларах
price_hkdnumber(float)falseнетЦена гонконгского доллара
original_pricenumber(float)falseнетПервоначальная цена (юаней)
original_usd_pricenumber(float)falseнетПервоначальная цена (долл. США)
original_price_hkdnumber(float)falseнетПервоначальная цена (HKD)
local_pricenumber(float)falseнетЛокализованная цена (зависит от предпочтительной валюты)
local_original_pricenumber(float)falseнетЛокализованная исходная цена (зависит от предпочтительной валюты)
preferred_currencystringfalseнетРекомендуется отображать валюту, например usd/cny/hkd.
support_currenciesstringfalseнетСписок поддерживаемых валют, разделенных запятыми, например usd,cny.
flow_valuenumber(float)falseнетТрафик тарифного плана по умолчанию (ГБ)
flow_givenumber(float)falseнетБесплатный трафик (ГБ)
balance_givenumber(float)falseнетБонус на пополнение баланса
balance_valuenumber(float)falseнетСумма пополнения
time_validitynumber(float)falseнетСрок действия стандартных планов по умолчанию
time_pricenumber(float)falseнетСтоимость стандартного пакета за IP
time_daysintegerfalseнетКоличество дней действия, например 30/90/180/365.
tip1stringfalseнетОписание этикетки 1
tip2stringfalseнетОписание этикетки 2
introduce[string]falseнетТекстовый вводный список
region_list_idintegerfalseнетИдентификатор региона
renew_product_liststringfalseнетСписок идентификаторов возобновляемых пакетов (через запятую)
parent_product_typeintegerfalseнетТип родительского пакета (действителен, если тип = 19): 14 или 25.
total_countintegerfalseнетОбщий запас, 0 означает отсутствие ограничений.
remain_countintegerfalseнетоставшийся запас
extension_of_time_days[integer]falseнетСписок кратных продолжительности. Если он пуст или содержит только 1, это означает, что он не поддерживается.
time_days_price_ratenumber(float)falseнетЦеновой коэффициент продолжительности, цена × (1 + (кратный-1) × ставка)
descobjectfalseнетИнформация об описании пакета
» subtitlestringfalseнетсубтитры
» flow_valuenumber(float)falseнетnone
» flow_givenumber(float)falseнетnone
» balance_givenumber(float)falseнетnone
» time_validitynumber(float)falseнетnone
» time_pricenumber(float)falseнетnone
» tip1stringfalseнетnone
» tip2stringfalseнетnone
» introduce[string]falseнетnone
skuobjectfalseнетПараметры спецификации (возвращаются, если тип = 11)
» bandwidth_list[object]falseнетСписок характеристик пропускной способности
»» idintegerfalseнетnone
»» valueintegerfalseнетЗначение пропускной способности (Мбит/с)
»» pricenumber(float)falseнетnone
»» price_usdnumber(float)falseнетnone
»» price_hkdnumber(float)falseнетnone
» duration_list[object]falseнетСписок спецификаций длительности
»» idintegerfalseнетnone
»» valueintegerfalseнетПродолжительность (дни)
»» pricenumber(float)falseнетnone
»» price_usdnumber(float)falseнетnone
»» price_hkdnumber(float)falseнетnone
» concurrency_list[object]falseнетСписок спецификаций параллелизма
»» idintegerfalseнетnone
»» valueintegerfalseнетКоличество параллелизма
»» pricenumber(float)falseнетnone
»» price_usdnumber(float)falseнетnone
»» price_hkdnumber(float)falseнетnone

WhiteIp

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

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
ipstringfalseнетnone
remarkstringfalseнетnone
created_atstring(date-time)falseнетnone

WhitelistAccount

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

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
usernamestringfalseнетnone
limitintegerfalseнетnone
usedintegerfalseнетnone
statusintegerfalseнетnone

Coupon

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

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
namestringfalseнетnone
codestringfalseнетnone
discountnumber(float)falseнетnone
expire_timestring(date-time)falseнетnone

Article

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

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
titlestringfalseнетnone
contentstringfalseнетnone
created_atstring(date-time)falseнетnone

Pagination

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

Свойства

ИмяТипОбязательноОграниченияОписание
totalintegerfalseнетnone
page_nointegerfalseнетnone
page_sizeintegerfalseнетnone
total_pagesintegerfalseнетnone

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

Снимок конфигурации автоматического продления одного пакета

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетnone
user_idintegerfalseнетnone
team_idResourceSpaceIdfalseнетИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
team_user_idintegerfalseнетnone
product_typeintegerfalseнетnone
left_trafficintegerfalseнетУстаревшее поле
left_daysintegerfalseнетУстаревшее поле
user_product_idintegerfalseнетnone
product_idintegerfalseнетУстаревшее поле
statusintegerfalseнет0=отключить, 1=включить
currencystringfalseнетnone
agreed_pricenumberfalseнетСогласованная общая стоимость
agreed_bandwidth_pricenumberfalseнетСогласованная цена за единицу полосы пропускания для Пакета 11
agreed_concurrency_pricenumberfalseнетСогласованная цена за единицу пакета 11
bandwidth_idintegerfalseнетnone
concurrency_idintegerfalseнетnone
durationintegerfalseнетСрок продления, ед. день
renew_product_idintegerfalseнетnone
days_before_expireintegerfalseнетnone
traffic_thresholdintegerfalseнетПорог трафика, единица измерения базы данных, КБ
parent_product_typeintegerfalseнетnone
created_atstringfalseнетnone
updated_atstringfalseнетnone

Допустимые значения

СвойствоЗначение
status0
status1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетnone
user_idintegertrueнетnone
team_idResourceSpaceIdtrueнетИдентификация пространства государственных ресурсов; опустите team_id или передайте пустую строку при запросе личного пространства и пустую строку при ответе на личное пространство; и число 0, и строка «0» незаконны, а в командном пространстве используется 6-12-значный публичный идентификатор команды.
team_user_idintegertrueнетnone
config_idintegertrueнетnone
user_product_idintegertrueнетnone
product_typeintegertrueнетnone
renew_product_idintegertrueнетnone
order_idintegertrueнетnone
feenumbertrueнетnone
currencystringtrueнетnone
before_expired_atstring,nullfalseнетnone
after_expired_atstring,nullfalseнетnone
before_remaininteger(int64)trueнетnone
after_remaininteger(int64)trueнетnone
trigger_typeintegertrueнет0=до истечения срока действия, 1=недостаточно трафика
statusintegertrueнет1 = успех, 2 = отозван, 3 = неудача
revoke_atstring,nullfalseнетnone
revoke_remarkstringtrueнетnone
created_atstringtrueнетnone
updated_atstringtrueнетnone

Допустимые значения

СвойствоЗначение
trigger_type0
trigger_type1
status1
status2
status3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
typestringtrueнетnone
start_atstringtrueнетnone
end_atstringtrueнетnone
target_expired_atstringtrueнетnone
timezonestringtrueнетnone

Допустимые значения

СвойствоЗначение
typecurrent
typenext

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegerfalseнетИдентификатор исторической платежной информации
user_product_idintegertrueнетnone
product_idintegertrueнетnone
product_typeintegertrueнетnone
parent_product_typeintegertrueнетnone
titlestringtrueнетnone
expired_atstringtrueнетnone
target_expired_atstringtrueнетnone
renew_daysintegertrueнетnone
unit_month_pricenumberfalseнетnone
pay_feenumbertrueнетnone
currencystringtrueнетnone
bandwidthintegerfalseнетnone
bandwidth_mbspnumberfalseнетЗначение преобразования пропускной способности
concurrencyintegerfalseнетnone
ipstringfalseнетСтатический IP-пакет возвращается
country_codestringfalseнетСтатический IP-пакет возвращается
paid_atstring,nullfalseнетnone
refunded_atstring,nullfalseнетnone
created_atstringfalseнетnone
updated_atstringfalseнетnone

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

Свойства

ИмяТипОбязательноОграниченияОписание
idintegertrueнетnone
invoice_nostringtrueнетnone
invoice_amountnumbertrueнетnone
invoice_download_urlstringtrueнетnone
statusintegertrueнетnone
remarkstringtrueнетnone
order_ids[integer]trueнетnone
created_atintegertrueнетВременная метка Unix
invoice_infoanytrueнетnone

oneOf

ИмяТипОбязательноОграниченияОписание
» anonymousobjectfalseнетnone
»» invoice_codestringtrueнетnone
»» namestringtrueнетnone
»» org_namestringtrueнетnone
»» role_typeintegertrueнетnone
»» invoice_typeintegertrueнетnone

xor

ИмяТипОбязательноОграниченияОписание
» anonymousnullfalseнетnone

Допустимые значения

СвойствоЗначение
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

Свойства

ИмяТипОбязательноОграниченияОписание
trade_nostringtrueнетnone
pm_idintegertrueнетnone
pay_methodintegertrueнетnone
trade_typestringtrueнетnone
country_codestringtrueнетnone
currencystringtrueнетnone
goods_feenumbertrueнетnone
discount_feenumbertrueнетnone
handling_feenumbertrueнетnone
pay_feenumbertrueнетnone
total_feenumbertrueнетnone
pay_method_infoanytrueнетnone

oneOf

ИмяТипОбязательноОграниченияОписание
» anonymousobjectfalseнетnone
»» idintegertrueнетnone
»» typeintegertrueнетnone
»» titlestringtrueнетnone
»» groupstringtrueнетnone
»» handling_ratenumbertrueнетnone
»» handling_feenumbertrueнетnone
»» handling_fee_currencystringtrueнетnone
»» handling_fee_convertednumbertrueнетnone

xor

ИмяТипОбязательноОграниченияОписание
» anonymousnullfalseнетnone

continued

ИмяТипОбязательноОграниченияОписание
originobjecttrueнетnone
» pm_idintegertrueнетnone
» pay_methodintegertrueнетnone
» goods_feenumbertrueнетnone
» discount_feenumbertrueнетnone
» handling_feenumbertrueнетnone
» pay_feenumbertrueнетnone
» total_feenumbertrueнетnone