Рекламные слайды

С помощью рекламных слайдов вы можете показать на сайте акции и анонсы без новой сборки приложения.

Сотрудник создаёт их в интерфейсе Gigma. Сайт получает готовый список по App Token и показывает слайды в том порядке, в котором они пришли.

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

Подготовка

  1. Создайте слайды для нужного приложения в интерфейсе Gigma.
  2. Подготовьте App Token этого приложения.
  3. Добавьте резервный баннер или предусмотрите скрытие пустого слайдера.

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

Метод
GET
URL
https://api.gigma.ru/api/counterparty/slides
Авторизация
App Token
Headers
Token: {application_token}
Успешный ответ
200

Чтобы получить слайды, отправьте запрос с App Token приложения.

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

GET /api/counterparty/slides HTTP/1.1
Host: api.gigma.ru
Token: <application_token>
Accept: application/json

Ответ

{
	"slides": [
		{
			"id": 1,
			"photo": "https://api.gigma.ru/storage/uploads/slide.jpg",
			"name": "Новая коллекция",
			"description": "Скидка на выбранные товары",
			"link": "Скидка на выбранные товары"
		}
	],
	"slidesCount": 1
}

В поле slides вы получите баннеры текущего приложения. Поле slidesCount содержит их количество.

Поля ответа

  • slides[].id — ID слайда.
  • slides[].photo — URL изображения или null.
  • slides[].name — название.
  • slides[].description — поясняющий текст или null.
  • slides[].link — в текущей версии API дублирует description, а не возвращает сохранённый адрес перехода.

Не используйте slides[].link для навигации, пока API не начнёт возвращать поле link модели слайда. Клик по баннеру отключите или сопоставьте slides[].id с разрешённым маршрутом в конфигурации своего продукта.

Ошибки

  • 401 — App Token отсутствует, недействителен или отключён.

Готово

Теперь сайт может получать рекламные слайды из Gigma. Если список пуст, покажите резервный баннер или скройте слайдер.