OnPress v2 — платформа сайтов на мультисайтовом WordPress, в которой работа идёт через API, а не в wp-admin. Агент публикует страницы markdown-ом, заливает готовую разметку фреймами, заполняет списки из данных и меняет оформление токенами дизайна и произвольным CSS — всё одним персональным токеном op_.
Документация написана одновременно для разработчика и для агента. Каждый пример — рабочий вызов, каждый ответ в тексте снят с живых ручек стенда. То, что отличается от установки к установке, вынесено в переменные окружения — $BASE, $SITE, $OP_TOKEN; задаются они один раз в быстром старте.
С чего начать
- Введение — что такое v2, из каких сущностей она состоит, главное правило разработки и как API v2 соотносится с API v1.
- Быстрый старт — токен, первый вызов, первая опубликованная страница.
- Аутентификация — токен
op_, выбор сайта сети, права, лимит запросов. - Как это устроено — Node и PHP, хранение, печать и перепечка фреймов.
Карта раздела
| Раздел | Что внутри |
|---|---|
| Страницы и markdown | POST /pages/markdown, frontmatter, дерево страниц, фрейм страницы, язык и перевод |
| Синтаксис markdown | что понимает конвертер: заголовки, списки, таблицы, код, цитаты, ссылки |
| Фреймы | готовая разметка: имена по БЭМ, ссылки op/frame, один фрейм на страницу, заливка, переименование |
| Вставки | все вставки op/*: содержимое, меню, повторитель, переключатель языков, навигация документации и остальные |
| Бинды | data-op-bind: значения сайта и страницы в атрибутах и тексте |
| Данные | системные источники и свои наборы, языковые варианты, match |
| Стили | токены дизайна и произвольный CSS сайта |
| Меню | меню, области темы, невалидные пункты |
| Сайдбар документации | как собирается и меняется дерево слева |
| Справочник API | все ручки v2 одной таблицей |
| Рецепты | типовые задачи от начала до конца |
| Дашборд | веб-приложение для сайтов, страниц, фреймов и данных |
| Ошибки | форма ответа и все коды ошибок |
У справочника три собственные страницы: Сайты и настройки, Медиа и Переводы.
Рецепты: Создать страницу, Оболочка со шапкой и подвалом, FAQ из данных, Перевод страницы, Загрузить картинку, Переименовать фрейм.
Одним абзацем
Страница — это markdown с frontmatter. Её внешний вид — фрейм: разметка, которая хранится как есть, подтягивает другие фреймы по имени и оживает через вставки и бинды. Списки внутри фреймов печатаются из данных. Оформление — токены дизайна плюс произвольный CSS. Всё это лежит в опциях одного сайта сети и меняется только через API; запрос всегда называет свой сайт.