Документация OnPress v2
OnPress v2 — платформа сайтов, у которой рабочее место не админка, а API. Страница публикуется запросом с markdown, внешний вид задаёт загруженная разметка (фрейм), списки на страницах берутся из наборов данных, оформление правится токенами и собственным CSS. Всё это делается одним персональным токеном через https://onpress.pro/api/v2/, а дашборд https://onpress.pro/dashboard/ показывает то же состояние глазами.
Документация написана так, чтобы по ней можно было работать без нас: каждый пример проверен на живом API, каждый код ошибки взят из кода сервиса. Если вы агент — читайте страницы целиком, по порядку, и держите под рукой справочник.
С чего начать
- Как устроена платформа — сущности, их связи и то, как страница собирается по шаблону. Без этой страницы остальное читается как набор ручек.
- Быстрый старт — от токена до опубликованной страницы со своим фреймом за десять запросов.
- Доступ, роли и выбор сайта — токен, права, адресация сайта, лимиты и форма ошибок.
Разделы
- Страницы — публикация из markdown, чтение, выгрузка, правка полей, удаление, дерево адресов. Внутри: все поля frontmatter, синтаксис markdown, языки и переводы страниц.
- Фреймы — готовая разметка, в которой собирается страница. Внутри: все вставки onpress/, бинды data-op-bind, сборка страницы и статическая копия.
- Наборы данных и системные источники — списки для страниц: свои наборы, меню, языки, дерево страниц. Внутри: повторитель onpress/repeat.
- Стили и оформление — токены дизайна и собственный CSS сайта.
- Меню и сайдбар документации.
- Языки сайта, настройки, главная и кэш, SEO, медиа.
- Сайты и домены — создание, архив, удаление, смена домена (суперадмин).
- Пользователи и профиль — кто администрирует сайт, свой профиль и токен.
- Дашборд и вход — что есть в панели и как устроен вход.
- Рецепты — типовые задачи от начала до конца: сайт с нуля, документация, лендинг, FAQ, многоязычный сайт, меню, перенос страницы.
- Справочник API — каждый маршрут с параметрами, примером запроса и ответа и кодами отказов.
- Ошибки и частые проблемы — что означает каждый отказ и что делать, плюс полная таблица кодов.
Соглашения в примерах
Все примеры — curl в bash. Перед работой задайте три переменные, и любой пример можно копировать без правок:
export OP_TOKEN=op_ВАШ_ТОКЕН # личный токен: дашборд → Настройки → API-ключи
export API=https://onpress.pro/api/v2 # точка входа API v2
export SITE=ВАШ_SITE_ID # девять знаков, например из GET /sites/{номер}
Как получить токен и SITE — в быстром старте и на странице доступа. Ответы в примерах сняты на тестовом сайте test.onpress.pro; длинные поля (хеши, списки) сокращены многоточием. Где ответ большой, показана его значимая часть.
Тела запросов — JSON, поэтому markdown страницы удобнее собирать через jq: jq -n --rawfile md page.md '{markdown: $md}' превращает файл в корректную JSON-строку со всеми переводами строк и кавычками.
Что изменилось по сравнению с v1
Первая версия (/wp-json/onpress/v1/, документация — в разделе v1) продолжает работать, но в v2 другая модель, и переносить привычки оттуда нельзя. Шаблонов темы нет — вид страницы задаёт фрейм, поле template принимается и игнорируется. Типа у фрейма нет, адреса у фрейма нет, человеческого имени у фрейма нет: фрейм называется слагом по БЭМ, а адрес принадлежит странице. Вставки пишутся своим синтаксисом <!-- onpress/… --> без префикса wp:. Сайт называется в пути: /api/v2/site/{siteId}/…, а не номером блога. Ролей ровно две — администратор сайта и суперадмин сети. Вход в дашборд — через Firebase (почта или Google), а не паролем WordPress; op_-токен остаётся способом авторизации запросов для агентов и скриптов.