Перейти к содержимому
Delivery API
Прежде чем рассчитывать на какую-либо функцию, проверьте статус возможностей.

ОбзорС чего начать

Как работает Atlas

Организации, сайты, окружения, контракт сайта, публикация и доставка на одной странице.

Эта страница переведена с английского. При любых расхождениях действует английская версия. Читать на английском

Понятие Что это
Организация Ваша компания. Ей принадлежат сайты, люди и тарифный план.
Сайт Один веб-сайт. Контент, медиа, доступ людей и настройки никогда не пересекаются между сайтами.
Окружение У каждого сайта есть Development и Production. Вы работаете в Development; Production отдаёт только одобренный релиз.
Контракт сайта JSON-описание вашего сайта: его компонентов и их типизированных полей, типов страниц, коллекций, глобальных блоков шапки и подвала, медиапрофилей и дизайн-токенов.
Страница Маршрут вашего сайта (например, /about), состоящий из секций. Каждая секция — один из компонентов вашего контракта со значениями его полей.
Запись Один элемент коллекции, например товар или новость.
Глобальный блок Контент, общий для нескольких страниц, например шапка и подвал сайта.
Токен доставки Серверный токен, который ваш сайт использует для чтения опубликованного контента одного окружения.
Editor in Studio ──draft──▶ Atlas (Development) ──publish──▶ published revision
│
your website server ◀── Delivery API (HTTPS, delivery token)
│
your components render it ──▶ visitors
  1. Ваши разработчики описывают сайт в контракте сайта. Администратор сайта активирует его в Studio.
  2. Редакторы создают и изменяют страницы и записи как черновики. Черновики никогда не появляются на публичном сайте.
  3. Редакторы делают предпросмотр черновика в реальном дизайне вашего сайта, а затем публикуют. Каждая публикация — это неизменяемая ревизия, поэтому можно сделать откат.
  4. Ваш сайт читает опубликованный контент из Delivery API с помощью своего токена доставки, только из серверного кода.
  5. При публикации Atlas отправляет подписанный вебхук, чтобы ваш сайт обновил только затронутые страницы.
  • Каждый новый сайт начинает в Development. Контент редактируется и публикуется там.
  • Production выключен, пока администратор сайта не включит его — после того как релиз прошёл все проверки и его одобрил человек с правом одобрения.
  • Production отдаёт только свой действующий подписанный релиз: замороженный снимок одобренного контента. Редактирование в Development никогда не меняет Production до следующего одобренного релиза.
  • Переключение окружения в Studio лишь меняет то, на что вы смотрите. Контент оно не меняет никогда.

Подробнее: Development и Production.

Atlas не запускается на вашем сайте. Ваши разработчики добавляют небольшой объём кода:

  • серверный клиент для Delivery API;
  • отображение секций через ваши существующие компоненты;
  • резервный вариант: если Atlas недоступен или для страницы ничего не опубликовано, сайт отдаёт встроенный контент;
  • маршрут предпросмотра черновика, приёмник вебхуков и отчёт о сборке.

В руководстве по подключению каждый из этих пунктов разобран по шагам.