Страницы

В данном разделе описаны административные и публичные запросы для работы со страницами и их разделами. Вы сможете узнать, как получить данные, управлять страницами и их разделами, а также ознакомиться с примерами ответов API.

Административные запросы

Административные запросы позволяют создавать, редактировать, удалять, публиковать страницы и разделы. Ниже представлен список доступных административных запросов:

Страницы:
  • GET /core/pages/items — получение списка всех страниц.
  • GET /core/pages/items/:id — получение данных о конкретной странице.
  • POST /core/pages/items/add — создание новой страницы.
  • POST /core/pages/items/:id — обновление страницы.
  • POST /core/pages/items/:id/publish — публикация страницы.
  • POST /core/pages/items/:id/delete — удаление страницы.
Разделы страниц:
  • GET /core/pages/sections — получение списка всех разделов страниц.
  • GET /core/pages/sections/:id — получение данных о конкретном разделе страницы.
  • POST /core/pages/sections/add — создание нового раздела страницы.
  • POST /core/pages/sections/:id — обновление раздела страницы.
  • POST /core/pages/sections/:id/publish — публикация раздела страницы.
  • POST /core/pages/sections/:id/delete — удаление раздела страницы.
С детальным описанием запросов вы можете ознакомиться в соответствующих разделах.

Публичные запросы

Публичные запросы позволяют получать данные о страницах и разделах страниц. Динамическая структура эндпоинта позволяет работать с любыми страницами и разделами по их имени.

Страницы:
GET домен/pages/{ имя страницы }
Разделы страниц:
GET домен/pages/sections/{ имя раздела }

Примеры

Пример запроса страницы:
GET
/pages/test

При успешном запросе, ответ будет выглядеть так:

1{
2  "id": 367,
3  "name": "Тестовая страница",
4  "url": "test-page",
5  "title": "Тестовая страница",
6  "description": "Описание страницы",
7  "active": true,
8  "parentId": null,
9  "hits": 10,
10  "sort": 1
11}

Интерфейс для работы с ответом:

1interface IPages {
2  id: number | null;
3  name: string;
4  url: string;
5  title: string;
6  description: string;
7  active: boolean;
8  parentId: number | null;
9  hits: number;
10  sort: number;
11}
Пример запроса раздела:
GET
/pages/sections/test-section

При успешном запросе, ответ будет выглядеть так:

1{
2  "id": 12,
3  "name": "Тестовый раздел",
4  "url": "test-section",
5  "description": "Описание раздела",
6  "active": true,
7  "parentId": null,
8  "hits": 5,
9  "sort": 10
10}

Интерфейс для работы с разделами:

1interface IPageSection {
2  id: number | null;
3  name: string;
4  url: string;
5  description: string;
6  active: boolean;
7  parentId: number | null;
8  hits: number;
9  sort: number;
10}