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Массив групп
idid группы
nameНазвание группы
countКол-во бэклинков в группе

Error

HTTP-кодСообщение об ошибке
403Access denied (wrong site_id)

Создание группы бэклинков

Метод позволяет создать группу бэклинков сайта.

Формат запроса

POST /backlink-groups/{site_id}
{
“name”: “Group name”
}

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

ИмяОбязательныйОписание
site_idДаid сайта
nameДаНазвание группы

Результат

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

Пример

{
“group_id”: 2
}

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

ИмяОписание
group_idid созданной группы бэклинков

Error

HTTP-кодСообщение об ошибке
403Access denied (wrong site_id)
400Invalid name
400Group already exists

Удаление группы бэклинков

Метод позволяет удалить группу бэклинков сайта.

Формат запроса

DELETE /backlink-groups/{site_id}?id={id}

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

ИмяОбязательныйОписание
site_idДаid сайта
idДаid группы бэклинков

Результат

В случае успеха сервер возвращает HTTP 204.

Ошибки

HTTP-кодСообщение об ошибке
403Access denied (wrong site_id)
400Invalid group id
400Group does not exist

Переименование группы бэклинков

Метод позволяет изменить название группы бэклинков сайта.

Формат запроса

PUT /backlink-groups/{site_id}
{
“id”: 2,
“name”: “New group name”
}

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

ИмяОбязательныйОписание
site_idДаid сайта
idДаid группы бэклинков
nameДаНовое название группы бэклинков

Результат

В случае успеха сервер возвращает HTTP 204.

Error

HTTP-кодСообщение об ошибке
403Access denied (wrong site_id)
400Invalid name
400Group 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-кодСообщение об ошибке
403Access denied (wrong site_id)
400Invalid group ids
400Backlink group ids
400Ids of groups or backlinks are required