Skip to Content
Справочник APIAPI страниц

API страниц

Эндпоинты для управления страницами в системе.

Получение списка страниц

Получение полного списка страниц.

Запрос

GET /api/flute-pages

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. 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" } ] }

Поля ответа

ПолеТипОписание
pagesarrayМассив страниц
idintegerID страницы
titlestringЗаголовок страницы
slugstringURL-совместимый идентификатор
is_activebooleanСтатус активности страницы
created_atstringДата создания

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса

Получение данных страницы

Получение детальной информации о конкретной странице.

Запрос

GET /api/flute-pages/{id}

Параметры пути

НазваниеТипОписание
idintegerID страницы

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. 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" } }

Поля ответа

ПолеТипОписание
pageobjectОбъект страницы
idintegerID страницы
titlestringЗаголовок страницы
slugstringURL-совместимый идентификатор
contentstringHTML содержимое страницы
meta_titlestringMETA заголовок для SEO
meta_descriptionstringMETA описание для SEO
is_activebooleanСтатус активности страницы
created_atstringДата создания
updated_atstringДата обновления

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Страница не найдена

Создание страницы

Создание новой страницы в системе.

Запрос

POST /api/flute-pages

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

{ "title": "Новая страница", "slug": "new-page", "content": "<h1>Новая страница</h1><p>Содержимое новой страницы.</p>", "meta_title": "Новая страница - Наш сайт", "meta_description": "Описание новой страницы", "is_active": true }

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

НазваниеТипОписание
titlestringОбязательный. Заголовок страницы
slugstringОбязательный. URL идентификатор
contentstringОбязательный. HTML содержимое
meta_titlestringНеобязательный. META заголовок
meta_descriptionstringНеобязательный. META описание
is_activebooleanНеобязательный. Статус активности

Ответ

{ "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}

Параметры пути

НазваниеТипОписание
idintegerID страницы

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

{ "title": "Обновленная страница", "content": "<h1>Обновленная страница</h1><p>Обновленное содержимое страницы.</p>", "meta_title": "Обновленная страница - Наш сайт", "meta_description": "Обновленное описание страницы", "is_active": true }

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

НазваниеТипОписание
titlestringНеобязательный. Заголовок страницы
slugstringНеобязательный. URL идентификатор
contentstringНеобязательный. HTML содержимое
meta_titlestringНеобязательный. META заголовок
meta_descriptionstringНеобязательный. META описание
is_activebooleanНеобязательный. Статус активности

Ответ

{ "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}

Параметры пути

НазваниеТипОписание
idintegerID страницы

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "message": "Page deleted successfully" }

Коды ответов

КодОписание
200Страница успешно удалена
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Страница не найдена

Получение блоков страницы

Получение списка блоков, привязанных к странице.

Запрос

GET /api/flute-pages/{id}/blocks

Параметры пути

НазваниеТипОписание
idintegerID страницы

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. 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 } ] }

Поля ответа

ПолеТипОписание
blocksarrayМассив блоков
idintegerID блока
typestringТип блока (text, image, etc)
contentmixedСодержимое блока
orderintegerПорядок отображения

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Страница не найдена