API для группы бэклинков
Список групп бэклинков
Метод позволяет получить список и количество групп бэклинков сайта.
Формат запроса
GET /backlink-groups/{site_id}
Параметры в запросе
| Имя | Обязательный | Описание | 
| site_id | Да | id сайта | 
Результат
В случае успеха сервер возвращает список и количество групп бэклинков сайта.
Пример
{
    "total_groups": 2,
    "groups": [
        {
            "id": 1,
            "name": "General",
            "count": 5
        },
        {
            "id": 2,
            "name": "Second group",
            "count": 1
        }
    ]
}
Параметры ответа
| Имя | Описание | 
| total_groups | Общее кол-во групп | 
| groups | Массив групп | 
| id | id группы | 
| name | Название группы | 
| count | Кол-во бэклинков в группе | 
Error
| HTTP-код | Сообщение об ошибке | 
| 403 | Access denied (wrong site_id) | 
Создание группы бэклинков
Метод позволяет создать группу бэклинков сайта.
Формат запроса
POST /backlink-groups/{site_id}
{
    "name": "Group name"
}
Параметры в запросе
| Имя | Обязательный | Описание | 
| site_id | Да | id сайта | 
| name | Да | Название группы | 
Результат
В случае успеха сервер возвращает id созданной группы бэклинков сайта.
Пример
Параметры ответа
| Имя | Описание | 
| group_id | id созданной группы бэклинков | 
Error
| HTTP-код | Сообщение об ошибке | 
| 403 | Access denied (wrong site_id) | 
| 400 | Invalid name | 
| 400 | Group already exists | 
Удаление группы бэклинков
Метод позволяет удалить группу бэклинков сайта.
Формат запроса
DELETE /backlink-groups/{site_id}?id={id}
Параметры в запросе
| Имя | Обязательный | Описание | 
| site_id | Да | id сайта | 
| id | Да | id группы бэклинков | 
Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке | 
| 403 | Access denied (wrong site_id) | 
| 400 | Invalid group id | 
| 400 | Group does not exist | 
Переименование группы бэклинков
Метод позволяет изменить название группы бэклинков сайта.
Формат запроса
PUT /backlink-groups/{site_id}
{
    "id": 2,
    "name": "New group name"
}
Параметры в запросе
| Имя | Обязательный | Описание | 
| site_id | Да | id сайта | 
| id | Да | id группы бэклинков | 
| name | Да | Новое название группы бэклинков | 
Результат
В случае успеха сервер возвращает HTTP 204.
Error
| HTTP-код | Сообщение об ошибке | 
| 403 | Access denied (wrong site_id) | 
| 400 | Invalid name | 
| 400 | Group already exists | 
Перемещение бэклинков из одной группы в другую
Метод позволяет переместить бэклинки из одной группы в другую.
Формат запроса
POST /backlink-groups/{site_id}/move
{
    "id": 1,
    "backlink_ids": [1],
    "group_ids": [2]
}
Параметры в запросе
| Имя | Обязательный | Описание | 
| site_id | Да | id сайта | 
| id | Да | id группы бэклинков, в которую будет перемещение | 
| backlink_ids | Нет | Массив ids бэклинков, которые нужно переместить | 
| group_ids | Нет | Массив ids групп бэклинков, которые нужно переместить | 
Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке | 
| 403 | Access denied (wrong site_id) | 
| 400 | Invalid group ids | 
| 400 | Backlink group ids | 
| 400 | Ids of groups or backlinks are required |