Перейти к содержанию

Группы

На этой странице представлены описания методов API, предназначенных для работы с группами устройств из раздела Постоянный доступ.

Список групп

Вы можете получить список всех групп аккаунта с помощью метода groups/list.

Группировка устройств

Подробнее об управлении группами устройств см. в руководстве Группировка устройств.

Запрос:
GET /v1/groups/list
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/groups/list" \
  -H "X-Api-Key: YOUR_API_KEY" \
Ответ:
Пример ответа
Данные ответа
{
    "data":[ {
        "id":1001,
        "name":"Los Angeles"
    },{
        "id":1002,
        "name":"Chicago"
    },{
        "id":1003,
        "name":"New York"
    }, ... ]
}
Название Тип Описание
id number Внутренний идентификатор группы
name string Название группы

Добавить устройство в группу

Вы можете добавить устройство в группу с помощью метода groups/agent/insert.

Запрос:
POST /v1/groups/agent/insert
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "agent_id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/agent/insert" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "agent_id": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы в системе
agent_id number Внутренний идентификатор устройства в системе
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Устройство успешно добавлено в группу
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа или устройство не найдены
  • 8 — Недостаточно прав

Удалить устройство из группы

Вы можете удалить устройство из группы с помощью метода groups/agent/remove.

Запрос:
POST /v1/groups/agent/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "agent_id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/agent/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "agent_id": <number>
  }'
Параметр Тип Значение
agent_id number Внутренний идентификатор устройства в системе
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Устройство успешно удалено из группы
  • 2 — Внутренняя ошибка сервера
  • 6 — Устройство не найдено
  • 8 — Недостаточно прав

Создать группу

Вы можете создать новую группу с помощью метода groups/create.

Запрос:
POST /v1/groups/create
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "name": <string>,
  "order": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/create" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "name": <string>,
    "order": <number>
  }'
Параметр Тип Значение
name string Имя создаваемой группы
order number Позиция создаваемой группы в списке
Ответ:
Пример ответа
Данные ответа
{
    "status": 0,
    "id": 1001
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно создана
  • 2 — Внутренняя ошибка сервера
  • 8 — Недостаточно прав
id number Внутренний идентификатор группы

Отредактировать группу

Вы можете изменить свойства группы с помощью метода groups/edit.

Запрос:
POST /v1/groups/edit
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "name": <string>,
  "order": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/edit" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "name": <string>,
    "order": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы
name string Новое имя группы
order number Новая позиция группы в списке
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно обновлена
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа не найдена
  • 8 — Недостаточно прав

Удалить группу

Вы можете удалить группу с помощью метода groups/remove.

Запрос:
POST /v1/groups/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно удалена
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа не найдена
  • 8 — Недостаточно прав