API для групп проектов

Добавление группы проектов

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

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

POST https://api4.seranking.com/site-groups
{ “name” : “text” }

Параметры

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

Результат

В случае успеха сервер вернет HTTP 201 и ID добавленной группы проектов.
ИмяОбязательныйОписание
group_idДаID добавленной группы проектов

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

{
“group_id”: 9545
}

Ошибки

HTTP-кодСообщение об ошибке
400Empty name

Изменение названия группы проектов

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

PUT https://api4.seranking.com/site-groups/{group_id}
{
“name”: “new name”
}

Параметры

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

Результат

В случае успеха сервер вернет HTTP 204.

Ошибки

HTTP-кодСообщение об ошибке
400Empty name
404Group not found

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

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

DELETE https://api4.seranking.com/site-groups/{group_id}

Результат

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

Ошибки

HTTP-кодСообщение об ошибке
404Group not found

Список групп проектов

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

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

 GET https://api4.seranking.com/site-groups

Результат

В случае успеха сервер возвращает список групп.

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

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

[
{
“id”: “123”,
“name”: “Group1”
},
{
“id”: “456”,
“name”: “Group2”
}
]

Перенос проектов в группу проектов

Описание

Метод позволяет перенести проекты из одной группы проектов в другую.

Параметры

ИмяОбязательныйОписание
site_idsДаМассив ID сайтов для перемещения

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

POST https://api4.seranking.com/site-groups/{group_id}/sites
{
“site_ids” : [1,2,3,4,5]
}

Результат

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

Ошибки

HTTP-кодСообщение об ошибке
404Group not found