Формат возвращаемых данных (кроме скачивания файлов) – JSON, и будет иметь следующие поля:
- rc — код результата выполнения (1 — для успешных запросов)
- rm — сообщение в текстовом виде
- data — массив возвращаемых данных
Для редактирования статьи достаточно отправить POST-запрос на URL https://verstka.io/api/open c параметрами:
- material_id — идентификатор материала (обязательный уникальный не нулевой, при верстке отдельной мобильной версии используйте префикс ‘M’ в этом поле)
- user_id — идентификатор текущего пользователя
- html_body — html статьи (пустой в случае новой статьи)
- api-key — API-key, выдаваемый при подключении к Verstka SaaS API
- callback_url — URL-адрес, на который придет запрос при сохранении статьи в редакторе
- host_name — с этого хоста редактор попытается скачать изображения статьи (если html_body содержит изображения)
- user_ip — IP-адрес текущего пользователя (дополнительный уровень безопасности при открытии редактора)
- callback_sign — md5 от сконкатенированных параметров в следующем порядке: secret, api-key, material_id, user_id, callback_url
- custom_fields — массив дополнительных параметров в формате JSON для включения дополнительных функций редактора
Возможные ключи массива custom_fields :
Верстка многостраничного сайта для самых маленьких, html/css/js подробное объяснение
- auth_user и auth_pw — если host_name закрыт с помощью http-авторизации
- fonts.css — относительный путь до CSS-файла со шрифтами для подключения к редактору (описан ниже)
- любые дополнительные данные (будут возвращены при сохранении статьи в неизменном виде)
В ответ Verstka API вернет в виде JSON следующие поля данных:
- session_id — уникальный идентификатор сессии редактирования
- edit_url — URL страницы редактора для этой сессии
Также в ответе будут дополнительные поля:
- last_save — время последнего сохранения статьи (в случае если статья недавно редактировалась)
- contents — URL для получения содержимого сессии редактирования (необходим только для интеграции без callback_url )
- client_folder — вычисленный относительный URL до статического контента статьи на host_name (для debug)
В случае если редактору не удастся скачать некоторые изображения статьи, вернутся следующие дополнительные параметры:
- lacking_pictures — список недостающих изображений
- upload_url — URL для загрузки посредством POST multipart/form-data
Сохранение статьи доступно в течение 48 часов с последнего взаимодействия (открытия или предыдущего сохранения) этой статьи
При нажатии пользователем кнопки «сохранить» в редакторе будет запрошен callback_url и с помощью POST переданы следующие параметры:
- material_id — идентификатор сохраняемого материала
- user_id — идентификатор текущего пользователя
- session_id — уникальный идентификатор сессии редактирования
- html_body — html сохраняемой статьи
- download_url — URL для скачивания статического контента
- custom_fields — JSON с дополнительными полями, переданными при открытии редактора
- callback_sign — цифорвая подпись запроса, генерируемая по следующему алгоритму:
md5 от сконкатенированных параметров в следующем порядке: secret, session_id, user_id, material_id, download_url, где secret — ключ, выдаваемый при подключении к Verstka SaaS API
Изображения статьи доступны по адресу download_url (возвращает список) и download_url / name (возвращает файл), где name — имя файла для скачивания.
Использование собственных шрифтов
Нужно собрать CSS-файл с определенными комментариями и зашитыми в base64 шрифтами, и тогда они автоматически появятся в Верстке.
Вверху CSS-файла нужно в комментах указать дефолтный шрифт, который будет выставляться при создании нового текстового объекта.
/* default_font_family: ‘formular’; */ /* default_font_weight: 400; */ /* default_font_size: 16px; */ /* default_line_height: 24px; */
/* font_name: ‘Formular’; */ /* font_style_name: ‘Light’; */
Вывод HTML-кода статьи должен сопровождаться подключением скрипта:
window.onVMSAPIReady = function( api ) < api.Article.enable( < > ); >;
Все параметры являются необязательными
- observe_selector – селекторы DOM-элементов, которые потенциально могут изменить положение статьи. Например, здесь указывается селектор баннера, расхлапывающегося над статьей.
Далее параметры если верстать отдельную мобильную версию невозможно:
- display_mode – переключает между режимами отображения статьи ( desktop или mobile ). Default: desktop ;
- auto_mobile_detect – автоматическое определение мобильных устройств по User Agent. Default: true ;
- mobile_max_width – ширина окна браузера, при которой происходит переключение между мобильной и десктопной версией статьи;
Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more
Источник: freesoft.dev
contentVerstka
contentVerstka — Дополнение позволяющее интегрировать verstka.io в ваш сайт.
При помощи этого дополнения вы сможете воспользоваться сервисом который позволяет создавать красивые публикации без особой сложности. Инструмент дает полную свободу в создании мультимедийной истории без привлечения программистов. Красивая анимация, параллакс, типографика, сетка в привычном для дизайнера интерфейсе.
Процесс интеграции довольно прост. Установите дополнение, введите ключи в системных настройках и пользуйтесь.
Быстрый старт:
Особенности использования с прочими дополнениями:
Некоторые дополнения делают небольшие изменения поля content и в итоге на выходе мы получаем изменённый вариант. Чтобы получить правильное отображение без изменений, рекомендую использовать сниппет clearContentVerstka который идёт в комплекте вместе с дополнением. Вызов достаточно прост, в том месте где необходим контент просто подставляем этот код
{$_modx->runSnippet(‘clearContent’, [‘content’=>$_modx->resource.content])}
[[clearContent? resource находится ещё чистый контент.
contentVerstka
contentVerstka — Дополнение позволяющее интегрировать verstka.io в ваш сайт.
При помощи этого дополнения вы сможете воспользоваться сервисом который позволяет создавать красивые публикации без особой сложности. Инструмент дает полную свободу в создании мультимедийной истории без привлечения программистов. Красивая анимация, параллакс, типографика, сетка в привычном для дизайнера интерфейсе.
Процесс интеграции довольно прост. Установите дополнение, введите ключи в системных настройках и пользуйтесь.
Внимание! Перед покупкой, необходимо получить ключи на сайте verstka.io
Это дополнение дает возможность быстро интегрировать сервис, но предоставляется без ключей.
Информация от verstka.io
Цена использования редактора «Verstka» составляет 36 000 руб. в месяц.
При этом мы не накладываем каких-либо ограничений на количество пользователей или создаваемых материалов. Так как после редактирования весь контент сохраняется у вас на сайте, то, даже если вы перестанете платить за редактор, созданные материалы продолжат работать, но без возможности редактирования.
Предоставляется бесплатный пробный период в течение первого месяца.
При заключении договора на год дается скидка в размере еще двух бесплатных месяцев.
Платная подписка, как и пробный период, распространяется на один домен и все его поддомены.
Быстрый старт:
Доступные настройки:
contentverstka_verstka_api_key — поле для ввода API ключа
contentverstka_verstka_secret — поле для ввода секретного ключа.
contentverstka_api_url — адрес по которому происходит обращение к verstka.io
contentverstka_files_path — путь к расположению компонента
contentverstka_fonts — путь к расположению файла fonts.css, этот файл используется для передачи собственных шрифтов на verstka.io
contentverstka_fonts_aviable — опция включения/отключения отправки собственных шрифтов.
contentverstka_image_folder — путь сохранения изображений с сервиса verstka.io
contentverstka_options — различные опции для вызова verstka.io на нашей странице, чаще всего можно оставлять пустым.
Особенности использования с прочими дополнениями:
Некоторые дополнения делают небольшие изменения поля content и в итоге на выходе мы получаем изменённый вариант. Чтобы получить правильное отображение без изменений, рекомендую использовать сниппет clearContentVerstka который идёт в комплекте вместе с дополнением. Вызов достаточно прост, в том месте где необходим контент просто подставляем этот код
{$_modx->runSnippet(‘clearContentVerstka’, [‘content’=>$_modx->resource.content])}
[[clearContentVerstka? resource находится ещё чистый контент.