NSocks

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

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

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

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

Базовые URL-адреса: "https://api.nsocks.com"

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

• HTTP-аутентификация, схема: bearer

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

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

Получить список ключей API

GET /ep/api-keys

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

Вернуться к примеру

Ответ 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
  }
}

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

Возвращаемая структура данных

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

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

Создание ключа API с помощью POST-запроса

POST /ep/api-keys/create

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

POST /ep/api-keys/enable

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

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

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

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

POST Отключить ключ API

POST /ep/api-keys/disable

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

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

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

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

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

POST /ep/api-keys/delete

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

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

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

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

POST-запрос для изменения примечаний к ключу API.

POST /ep/api-keys/update-remark

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

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

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

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

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

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

POST /ep/team/create

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

{
  "name": "string"
}

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

Получить список команд, доступных пользователю в данный момент.

GET /ep/team/list

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

Получить подробную информацию о команде

GET /ep/team/detail

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

POST для изменения названия команды

POST /ep/team/update-name

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

POST распускает команду

POST /ep/team/dissolve

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

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

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

GET-запрос для получения информации о статусе расформирования команды.

GET /ep/team/dissolve-status

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

Командные активы

Получить информацию о командных пакетах

GET /ep/team/product-info

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

Список ресурсов команды GET

GET /ep/team/assets

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

Получите личные активы, которые можно включить в команду.

GET /ep/team/assets/personal-candidates

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

POST /ep/team/assets/move-in

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

POST /ep/team/assets/move-out

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

Командный кошелек

GET-запрос, командный кошелек

GET /ep/team/wallet/detail

Требуется разрешение VIEW_BILLING. Командный кошелек отделен от индивидуальных балансов суперадминистратора и участников.

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

GET-запрос к команде: история транзакций кошелька

GET /ep/team/wallet/records

Требуется разрешение VIEW_BILLING. Суммы транзакций всегда положительные, а изменения в средствах указываются в поле «Направление».

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

Личный баланс переведен на командный кошелек.

POST /ep/team/wallet/transfer-in

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

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

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

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

POST Баланс команды переведен обратно на личный счет

POST /ep/team/wallet/transfer-out

Эта функция может быть вызвана только авторизованным суперадминистратором. Она автоматически списывает средства с кошелька команды и увеличивает баланс пополнения счета отдельного участника; она не изменяет общую сумму пополнения счета команды или отдельного участника. Ее можно использовать для восстановления баланса расформированных команд, но она не может быть вызвана расформированными командами.

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

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

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

Члены команды

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

GET /ep/team/members

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

Единый список участников команды GET

GET /ep/team/people

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

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

POST Изменение ролей участников

POST /ep/team/members/update-role

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

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

POST /ep/team/members/remove

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

ПОСТ - Покинуть команду

POST /ep/team/members/leave

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

{
  "team_id": "A1b2C3d4E5f6"
}

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

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

POST /ep/team/invitations/create

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

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

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "user@example.com",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

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

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

Список приглашений в команду GET

GET /ep/team/invitations

Доступ предоставляется только суперадминистраторам или администраторам команды; просроченные приглашения будут обновлены до статуса «просрочены» перед повторным получением.

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

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

GET /ep/team/invitations/preview

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

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

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

POST /ep/team/invitations/resend

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

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

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

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

Вернуться к примеру

Ответ 200

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

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

Возвращаемая структура данных

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

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

POST /ep/team/invitations/accept

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

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

{
  "invitation_token": "string"
}

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

POST /ep/team/invitations/reject

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

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

{
  "invitation_token": "string"
}

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

POST /ep/team/invitations/cancel

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

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

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

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

Вернуться к примеру

Ответ 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"
}

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

Возвращаемая структура данных

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

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

Получите информацию о пакетах баллов.

GET /web_v1/credit/info

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Отправьте POST-запрос для настройки автоматического пополнения баланса баллов.

POST /web_v1/credit/update-auto-supplement

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

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

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

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить запись об использовании баллов

GET /web_v1/credit/consumption-logs

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить Сбросить запись

GET /web_v1/credit/reset-logs

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить статистику по очкам через GET

GET /web_v1/credit/stats

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получайте ежедневную статистику по набранным очкам.

GET /web_v1/credit/daily-stats

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

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

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

GET /web_v1/credit/hourly-stats

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

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получите информацию о пакетах баллов.

GET /ep/credit/info

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить запись об использовании баллов

GET /ep/credit/consumption-logs

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить Сбросить запись

GET /ep/credit/reset-logs

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получить статистику по очкам через GET

GET /ep/credit/stats

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Получайте ежедневную статистику по набранным очкам.

GET /ep/credit/daily-stats

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

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

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

GET /ep/credit/hourly-stats

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

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

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

Вернуться к примеру

Ответ 200

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

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

Возвращаемая структура данных

Журнал активности Xcrawl

GET Retrieve Xcrawl Recent Tasks List

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

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

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

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

Вернуться к примеру

Ответ 200

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

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