API для групп проектов
Добавление группы проектов
Метод позволяет добавить группу проектов в аккаунт пользователя.
Формат запроса
POST https://api4.seranking.com/site-groups
{ “name” : “text” }
Параметры
| Имя | Обязательный | Описание |
| name | Да | Имя добавляемой группы проектов |
Результат
| В случае успеха сервер вернет HTTP 201 и ID добавленной группы проектов. |
| Имя | Обязательный | Описание |
| group_id | Да | ID добавленной группы проектов |
Пример ответа
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Empty name |
Изменение названия группы проектов
Формат запроса
PUT https://api4.seranking.com/site-groups/{group_id}
{
“name”: “new name”
}
Параметры
| Имя | Обязательный | Описание |
| name | Да | Новое название группы проектов |
Результат
В случае успеха сервер вернет HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Empty name |
| 404 | Group not found |
Удаление группы проектов
Формат запроса
DELETE https://api4.seranking.com/site-groups/{group_id}
Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Group 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-код | Сообщение об ошибке |
| 404 | Group not found |
