Перейти к содержанию

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

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

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

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

  • application_id[required] - ID приложения из справочника
  • page_type_id[nullable] - ID типа страницы из запроса
  • order_by[nullable, min: 3] - направление сортировки. Доступные значения: date_asc, date_desc, popularity_asc, popularity_desc.
  • query[nullable] - поисковая строка
  • page[nullable] - текущая страница (для пагинации)
  • per_page[nullable] - кол-во элементов на странице

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

https://beta.api.gigma.ru/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 - массив столбцов
  • pagination - объект с информацией, необходимой для пагинации
  • id - первичный ключ (ID страницы)
  • code - код страницы
  • date - дата создания страницы
  • title - объект с информацией о названии страницы
  • type - объект с информацией о типе страницы
  • slug - slug страницы
  • creator - объект с информацией о создателе страницы
  • status - статус публикации

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

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

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

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

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

https://beta.api.gigma.ru/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 - slug страницы/блока
  • title - название страницы
  • meta_title - meta-title страницы
  • preview - объект с информацией о превью страницы. Для получения информации о возвращаемых полях см. запрос
  • description - описание страницы
  • meta_description - meta-description страницы
  • content - контент страницы в формате HTML
  • application - объект с информацией о приложении, к которому привязана страница. Для получения информации о возвращаемых полях см. запрос
  • tags - массив объектов с информацией о тегах, которые привязаны к странице. Для получения информации о возвращаемых полях см. запрос

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

Метод: POST
URL: https://beta.api.gigma.ru/pages
Авторизация: 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-title страницы
  • preview_id[nullable] - ID превью из справочника
  • description[nullable] - описание страницы
  • meta_description[nullable] - meta-description страницы
  • content[nullable] - контент страницы в формате HTML
  • tags[array, nullable] - массив ID тегов, привязанных к странице из справочника

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

https://beta.api.gigma.ru/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://beta.api.gigma.ru/pages/{id}
Авторизация: 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-title страницы
  • preview_id[nullable] - ID превью из справочника
  • description[nullable] - описание страницы
  • meta_description[nullable] - meta-description страницы
  • content[nullable] - контент страницы в формате HTML
  • tags[array, nullable] - массив ID тегов, привязанных к странице из справочника

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

https://beta.api.gigma.ru/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://beta.api.gigma.ru/pages/{id}
Авторизация: Bearer token

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

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

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

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

Ответ

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

{
    "message": "Page successfully destroyed"
}

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

  • message - информационное поле

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

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

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

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

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

https://beta.api.gigma.ru/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 - дата/время добавления в систему