API страниц
Эндпоинты для управления страницами в системе.
Получение списка страниц
Получение полного списка страниц.
Запрос
GET /api/flute-pages
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"pages": [
{
"id": 1,
"title": "Главная страница",
"slug": "home",
"is_active": true,
"created_at": "2023-01-01T00:00:00Z"
},
{
"id": 2,
"title": "О нас",
"slug": "about",
"is_active": true,
"created_at": "2023-01-02T00:00:00Z"
}
]
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
pages | array | Массив страниц |
id | integer | ID страницы |
title | string | Заголовок страницы |
slug | string | URL-совместимый идентификатор |
is_active | boolean | Статус активности страницы |
created_at | string | Дата создания |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
Получение данных страницы
Получение детальной информации о конкретной странице.
Запрос
GET /api/flute-pages/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID страницы |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"page": {
"id": 1,
"title": "Главная страница",
"slug": "home",
"content": "<h1>Добро пожаловать!</h1><p>Это главная страница нашего сайта.</p>",
"meta_title": "Главная - Наш сайт",
"meta_description": "Главная страница нашего проекта",
"is_active": true,
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-10T00:00:00Z"
}
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
page | object | Объект страницы |
id | integer | ID страницы |
title | string | Заголовок страницы |
slug | string | URL-совместимый идентификатор |
content | string | HTML содержимое страницы |
meta_title | string | META заголовок для SEO |
meta_description | string | META описание для SEO |
is_active | boolean | Статус активности страницы |
created_at | string | Дата создания |
updated_at | string | Дата обновления |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Страница не найдена |
Создание страницы
Создание новой страницы в системе.
Запрос
POST /api/flute-pages
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"title": "Новая страница",
"slug": "new-page",
"content": "<h1>Новая страница</h1><p>Содержимое новой страницы.</p>",
"meta_title": "Новая страница - Наш сайт",
"meta_description": "Описание новой страницы",
"is_active": true
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
title | string | Обязательный. Заголовок страницы |
slug | string | Обязательный. URL идентификатор |
content | string | Обязательный. HTML содержимое |
meta_title | string | Необязательный. META заголовок |
meta_description | string | Необязательный. META описание |
is_active | boolean | Необязательный. Статус активности |
Ответ
{
"message": "Page created successfully",
"page": {
"id": 3,
"title": "Новая страница",
"slug": "new-page",
"content": "<h1>Новая страница</h1><p>Содержимое новой страницы.</p>",
"meta_title": "Новая страница - Наш сайт",
"meta_description": "Описание новой страницы",
"is_active": true,
"created_at": "2023-03-15T12:00:00Z"
}
}
Коды ответов
Код | Описание |
---|---|
201 | Страница успешно создана |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
422 | Неверные параметры запроса |
Обновление страницы
Обновление данных существующей страницы.
Запрос
PUT /api/flute-pages/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID страницы |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"title": "Обновленная страница",
"content": "<h1>Обновленная страница</h1><p>Обновленное содержимое страницы.</p>",
"meta_title": "Обновленная страница - Наш сайт",
"meta_description": "Обновленное описание страницы",
"is_active": true
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
title | string | Необязательный. Заголовок страницы |
slug | string | Необязательный. URL идентификатор |
content | string | Необязательный. HTML содержимое |
meta_title | string | Необязательный. META заголовок |
meta_description | string | Необязательный. META описание |
is_active | boolean | Необязательный. Статус активности |
Ответ
{
"message": "Page updated successfully",
"page": {
"id": 3,
"title": "Обновленная страница",
"slug": "new-page",
"content": "<h1>Обновленная страница</h1><p>Обновленное содержимое страницы.</p>",
"meta_title": "Обновленная страница - Наш сайт",
"meta_description": "Обновленное описание страницы",
"is_active": true,
"updated_at": "2023-03-16T14:30:00Z"
}
}
Коды ответов
Код | Описание |
---|---|
200 | Страница успешно обновлена |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Страница не найдена |
422 | Неверные параметры запроса |
Удаление страницы
Удаление страницы из системы.
Запрос
DELETE /api/flute-pages/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID страницы |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"message": "Page deleted successfully"
}
Коды ответов
Код | Описание |
---|---|
200 | Страница успешно удалена |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Страница не найдена |
Получение блоков страницы
Получение списка блоков, привязанных к странице.
Запрос
GET /api/flute-pages/{id}/blocks
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID страницы |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"blocks": [
{
"id": 1,
"type": "text",
"content": "<p>Это первый текстовый блок</p>",
"order": 1
},
{
"id": 2,
"type": "image",
"content": {
"url": "/uploads/image.jpg",
"alt": "Изображение",
"width": 800,
"height": 600
},
"order": 2
}
]
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
blocks | array | Массив блоков |
id | integer | ID блока |
type | string | Тип блока (text, image, etc) |
content | mixed | Содержимое блока |
order | integer | Порядок отображения |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Страница не найдена |