Skip to content

Работа с кабинетами

Список кабинетов

INFO

GET accounts/telegram/names

Пример использования:

http
https://client.adstat.pro/api/accounts/telegram/names

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

  • Authorization: "Bearer <access_token>"

Пример успешного ответа:

json
[
  {
    "account_uid": "ACC0000",
    "name": "string",
    "balance": 0,
    "mode": "string",
    "is_audience_allowed": false
  }
]

Описание параметров успешного ответа:

ПараметрОписание
account_uidИдентификатор кабинета
nameНаименование кабинета
balanceБаланс кабинета
modeВнутренний параметр для технических нужд
is_audience_allowedВнутренний параметр для технических нужд

Информация по отдельному кабинету

INFO

GET api/accounts/telegram/{account_uid}

Пример использования:

http
https://client.adstat.pro/api/accounts/telegram/ACC0000

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

  • Authorization: "Bearer <access_token>"

В URL метода необходимо передать Идентификатор кабинета - account_uid, который можно узнать из списка всех кабинетов

Пример успешного ответа:

json
{
  "account_uid": "ACC0000",
  "name": "string",
  "balance": 0,
  "mode": "string",
  "is_audience_allowed": false
}

Описание параметров успешного ответа:

ПараметрОписание
account_uidИдентификатор кабинета
nameНаименование кабинета
balanceБаланс кабинета
modeВнутренний параметр для технических нужд
is_audience_allowedВнутренний параметр для технических нужд

Подробная информация по кабинетам

INFO

GET accounts/telegram/?query-params

Пример использования:

http
https://client.adstat.pro/api/accounts/telegram/?limit=50&offset=0

Описание query-параметров:

ПараметрТипОписание
account_nameСтрокаФильтрация кабинетов по названию кабинета.
offsetЧислоСмещение в результирующем списке кабинетов.
limitЧислоМаксимальное количество кабинетов в ответе.
legal_nameСтрокаФильтрация кабинетов по юридическому названию.

Пример успешного ответа:

json
{
  "items": [
    {
      "account_id": "ACC0000",
      "account_name": "account name",
      "status": "active",
      "balance_total": 0,
      "balance_available": 0,
      "balance_active": 0,
      "balance_spent": 0,
      "objects": ["t.me/example"],
      "legal_name": "legal name",
      "category_key": "education",
      "category_name": "Образование"
    }
  ],
  "count": 1
}

Описание параметров успешного ответа:

ПолеТипОписание
itemsМассивСписок объектов с информацией о кабинетах.
account_idСтрокаУникальный идентификатор кабинета.
account_nameСтрокаНазвание кабинета.
statusСтрокаСтатус кабинета.
active, inactive
balance_totalЧислоОбщий баланс кабинета.
balance_availableЧислоСвободный баланс кабинета.
balance_activeЧислоБаланс остатка средств в объявлениях кабинета.
balance_spentЧислоПотраченный баланс кабинета.
objectsМассивСписок объектов рекламирования привязанных к кабинету.
legal_nameСтрокаЮридическое название кабинета.
category_keyСтрокаКлюч категории кабинета.
category_nameСтрокаНазвание категории кабинета.
countЧислоКоличество кабинетов в списке.

Вот улучшенная и стилистически выверенная версия текста:

ККТУ по умолчанию для кабинета

Метод позволяет назначить ККТУ по умолчанию для кабинета. Если при создании рекламной кампании (РК) ККТУ не указан вручную, и для кабинета настроен ККТУ по умолчанию — он будет автоматически применён к создаваемой РК.

Метод:

PATCH /api/accounts/set-default-kktu

Пример запроса:

http
https://client.adstat.pro/api/accounts/set-default-kktu

Параметры запроса (body):

ПараметрТипОписание
account_idstringУникальный идентификатор кабинета
kktu_idstringУникальный идентификатор ККТУ

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

json
{
  "account_id": "string",
  "kktu_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}