Страницы (контент)

Получение списка страниц (табличное представление)

Метод: GET
URL: https://api.gigma.ru/api/tables/pages
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

application_id [required] — ID приложения
page_type_id [nullable] — ID типа страницы
order_by [nullable] — сортировка: date_asc, date_desc, popularity_asc, popularity_desc
query [nullable] — поисковая строка
page [nullable] — номер страницы для пагинации
per_page [nullable] — элементов на странице

Пример запроса

https://api.gigma.ru/api/tables/pages?query=новость&application_id=23&page_type_id=1

Ответ

При успешном действии возвращается HTTP код 200.

{
    "columns": [
        {"id": 135, "table_id": 17, "order": 0, "key": "code", "has_icon": 0, "text": "Код"},
        {"id": 136, "table_id": 17, "order": 1, "key": "date", "has_icon": 0, "text": "Дата"},
        {"id": 137, "table_id": 17, "order": 2, "key": "title", "has_icon": 1, "text": "Название"},
        {"id": 138, "table_id": 17, "order": 3, "key": "type", "has_icon": 1, "text": "Тип контента"},
        {"id": 139, "table_id": 17, "order": 4, "key": "slug", "has_icon": 0, "text": "Slug"},
        {"id": 140, "table_id": 17, "order": 5, "key": "creator", "has_icon": 1, "text": "Создал"},
        {"id": 141, "table_id": 17, "order": 6, "key": "status", "has_icon": 0, "text": "Статус"}
    ],
    "contents": [
        {
            "id": 12,
            "code": null,
            "date": "13.05.2024",
            "title": {"icon": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg", "value": "Создание идивидуальго проекта"},
            "type": {"icon": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg", "value": "Страница"},
            "slug": "proektnye-raboty",
            "creator": {"icon": "https://beta.back.erp.itecho.ru/storage/uploads/hJsFVET0jAcRiqK3Zu2mdkFVFL4LktdrT6kB7la8.jpg", "value": "Иванов Василий", "link": "https://beta.gigma.ru/users/list-users/39"},
            "status": "Черновик"
        }
    ],
    "pagination": {
        "total": 9,
        "per_page": 1,
        "current_page": 1,
        "last_page": 9,
        "from": 1,
        "to": 1
    }
}

Описание полей ответа

columns — массив столбцов таблицы
contents — массив данных страниц (в табличном формате)
pagination — информация для пагинации
id — ID страницы
code — код страницы
date — дата создания (только в табличном представлении)
title — название с иконкой
type — тип страницы с иконкой
slug — идентификатор URL
creator — создатель с ссылкой
status — статус публикации (только в табличном представлении; в ресурсе GET /api/pages/{id} этого поля нет)

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

Метод: GET
URL: https://api.gigma.ru/api/pages/{id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

Параметры не передаются.

Пример запроса

https://api.gigma.ru/api/pages/12

Ответ

При успешном действии возвращается HTTP код 200.

{
    "page": {
        "id": 12,
        "code": null,
        "avatar": null,
        "is_page": true,
        "views_count": 27,
        "type": {
            "id": 1,
            "name": "Страница",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        },
        "creator": {
            "id": 39,
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/hJsFVET0jAcRiqK3Zu2mdkFVFL4LktdrT6kB7la8.jpg",
            "first_name": "Василий",
            "last_name": "Иванов",
            "middle_name": "Батькович",
            "name": "Иванов Василий"
        },
        "slug": "proektnye-raboty",
        "title": "Создание идивидуальго проекта",
        "meta_title": null,
        "preview": {
            "id": 2066,
            "name": "image1.png",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/iT6Bvuu2DQrFIAF9SMkqnVtyh8uXvECkpIt4OkgR.png",
            "link": null,
            "created_at": "2024-11-13T09:51:36.000000Z",
            "updated_at": "2024-11-13T09:51:36.000000Z"
        },
        "description": "Создание идивидуальго проекта",
        "meta_description": null,
        "content": "<p>В нашем интернет-магазине вы можете недорого купить скрабы для очищения и отшелушивания кожи. У нас представлена корейская косметика самых известных брендов, с подробным описанием, составами и отзывами покупателей. Мы предлагаем вам отшелушивающие скрабы по выгодной цене с доставкой по всей России, как в пункты выдачи заказов, так и по вашему персональному адресу. Возможен наложенный платеж. </p>",
        "application": {
            "id": 23,
            "name": "https://nsksm.ru",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-08T08:46:23.000000Z"
        },
        "created_at": "2024-05-13T05:29:39.000000Z"
    }
}

Описание полей ответа

id — ID страницы
code — код страницы
avatar — аватар страницы
is_page — флаг (true=страница, false=блок)
views_count — кол-во просмотров
type — информация о типе
creator — данные создателя
slug — URL-идентификатор
title — название
meta_title — meta-заголовок
preview — превью-изображение
description — описание
meta_description — meta-описание
content — контент в формате HTML
application — привязанное приложение
created_at — дата создания

Добавление страницы

Метод: POST
URL: https://api.gigma.ru/api/pages
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

code [nullable, unique] — код страницы
application_id [required] — ID приложения
avatar_id [nullable] — ID аватара
is_page [required] — флаг типа (true/false)
page_type_id [required] — ID типа страницы
slug [required, unique] — slug
title [required, min:3, max:255] — название
meta_title [nullable, min:3, max:255] — meta-заголовок
preview_id [nullable] — ID превью
description [nullable] — описание
meta_description [nullable] — meta-описание
content [nullable] — HTML-контент
tags [array, nullable] — массив ID тегов

Пример запроса

https://api.gigma.ru/api/pages

{
    "code": "1235",
    "application_id": 23,
    "avatar_id": 1,
    "is_page": true,
    "page_type_id": 1,
    "slug": "news-3",
    "title": "Скоро запуск веб-сайта!",
    "meta_title": "Запуск веб-сайта на платформе gigma.ru",
    "preview_id": 1,
    "description": "Описание текстовом формате",
    "meta_description": "Meta описание",
    "content": "HTML content",
    "tags": [1, 2]
}

Ответ

При успешном действии возвращается HTTP код 201.

{
    "page": {
        "id": 36,
        "code": "1235",
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "is_page": true,
        "views_count": null,
        "type": {
            "id": 1,
            "name": "Страница",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        },
        "creator": {
            "id": 39,
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/hJsFVET0jAcRiqK3Zu2mdkFVFL4LktdrT6kB7la8.jpg",
            "first_name": "Василий",
            "last_name": "Иванов",
            "middle_name": "Батькович",
            "name": "Иванов Василий"
        },
        "slug": "news-3",
        "title": "Скоро запуск веб-сайта!",
        "meta_title": "Запуск веб-сайта на платформе gigma.ru",
        "preview": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "description": "Описание текстовом формате",
        "meta_description": "Meta описание",
        "content": "HTML content",
        "application": {
            "id": 23,
            "name": "https://nsksm.ru",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-08T08:46:23.000000Z"
        },
        "tags": [
            {
                "id": 1,
                "name": "Важное",
                "avatar": "http://localhost:8000/storage/uploads/default.svg",
                "created_at": "2024-11-14T14:01:51.000000Z"
            },
            {
                "id": 2,
                "name": "Продукция",
                "avatar": "http://localhost:8000/storage/uploads/default.svg",
                "created_at": "2024-11-14T14:01:51.000000Z"
            }
        ],
        "created_at": "2024-11-27T09:34:29.000000Z"
    }
}

Описание полей ответа

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

Редактирование страницы (контента)

Метод: PUT
URL: https://api.gigma.ru/api/pages/{id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

code [nullable, unique] — код страницы
application_id [required] — ID приложения
avatar_id [nullable] — ID аватара
is_page [required] — флаг (true/false)
page_type_id [required] — ID типа страницы
slug [required, unique] — slug
title [required, min:3, max:255] — название
meta_title [nullable, min:3, max:255] — meta-заголовок
preview_id [nullable] — ID превью
description [nullable] — описание
meta_description [nullable] — meta-описание
content [nullable] — HTML-контент
tags [array, nullable] — массив ID тегов

Пример запроса

https://api.gigma.ru/api/pages/36

{
    "code": "1235",
    "application_id": 23,
    "avatar_id": 1,
    "is_page": true,
    "page_type_id": 1,
    "slug": "news-3",
    "title": "Скоро запуск веб-сайта!",
    "meta_title": "Запуск веб-сайта на платформе gigma.ru",
    "preview_id": 1,
    "description": "Описание текстовом формате",
    "meta_description": "Meta описание",
    "content": "HTML content",
    "tags": [1]
}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "page": {
        "id": 36,
        "code": "1235",
        "avatar": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "is_page": true,
        "views_count": 0,
        "type": {
            "id": 1,
            "name": "Страница",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-31T11:14:22.000000Z"
        },
        "creator": {
            "id": 39,
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/hJsFVET0jAcRiqK3Zu2mdkFVFL4LktdrT6kB7la8.jpg",
            "first_name": "Василий",
            "last_name": "Иванов",
            "middle_name": "Батькович",
            "name": "Иванов Василий"
        },
        "slug": "news-3",
        "title": "Скоро запуск веб-сайта!",
        "meta_title": "Запуск веб-сайта на платформе gigma.ru",
        "preview": {
            "id": 1,
            "name": "logo.svg",
            "type": {
                "id": 1,
                "name": "Трудовой договор",
                "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/yjohncMkjTSnvJ7FH4vksOtDYUy9pO2HDwmNU5Hc.svg",
            "link": null,
            "created_at": "2024-04-14T20:04:32.000000Z",
            "updated_at": "2024-04-14T20:04:32.000000Z"
        },
        "description": "Описание текстовом формате",
        "meta_description": "Meta описание",
        "content": "HTML content",
        "application": {
            "id": 23,
            "name": "https://nsksm.ru",
            "avatar": "https://beta.back.erp.itecho.ru/storage/uploads/default.svg",
            "created_at": "2024-10-08T08:46:23.000000Z"
        },
        "tags": [
            {
                "id": 1,
                "name": "Важное",
                "avatar": "http://localhost:8000/storage/uploads/default.svg",
                "created_at": "2024-11-14T14:01:51.000000Z"
            }
        ],
        "created_at": "2024-11-27T09:34:29.000000Z"
    }
}

Описание полей ответа

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

Удаление страницы (контента)

Метод: DELETE
URL: https://api.gigma.ru/api/pages/{id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

Параметры не передаются.

Пример запроса

https://api.gigma.ru/api/pages/41

Ответ

При успешном действии возвращается HTTP код 200.

{
    "message": "Page successfully destroyed"
}

Описание полей ответа

message — информационное сообщение о результате операции

Получение истории изменений страницы

Метод: GET
URL: https://api.gigma.ru/api/pages/{page}/history
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200 с записями истории: id, icon, color, title, description, datetime.

Получение списка тегов

Метод: GET
URL: https://api.gigma.ru/api/page_tags
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

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

Параметры не передаются.

Пример запроса

https://api.gigma.ru/api/page_tags

Ответ

При успешном действии возвращается HTTP код 200.

{
    "pageTags": [
        {
            "id": 1,
            "name": "Важное",
            "avatar": "http://localhost:8000/storage/uploads/default.svg",
            "created_at": "2024-11-14T14:01:51.000000Z"
        },
        {
            "id": 2,
            "name": "Продукция",
            "avatar": "http://localhost:8000/storage/uploads/default.svg",
            "created_at": "2024-11-14T14:01:51.000000Z"
        }
    ],
    "pageTagsCount": 2
}

Описание полей ответа

id — первичный ключ тега
name — название тега
avatar — URL аватара
created_at — дата добавления в систему
pageTagsCount — общее количество тегов