Справочник API

Точка входа: https://onpress.pro/api/v2. Все запросы и ответы — JSON в UTF-8. Авторизация — Authorization: Bearer op_… (или X-OnPress-Key) либо сессия дашборда. Лимит — 120 запросов в минуту на пользователя. Как выбирается сайт, какие роли нужны и в какой форме приходят ошибки — доступ.

Ручки сайта живут под /site/{siteId}: в таблицах ниже путь /pages означает https://onpress.pro/api/v2/site/{siteId}/pages. Они требуют администратора этого сайта или суперадмина. Тот же путь без префикса с сайтом в X-OnPress-Blog-Id, blog_id или domain тоже работает — это устаревший способ.

Ручки сети — /sites, /me, /auth, /health — без префикса сайта.

{ref} страницы — id, слаг или путь, где каждый слеш заменён тильдой (docs~api для /docs/api/). {ref} фрейма — id или слаг. {ref} меню — id, слаг, имя или область с тильдой (~header).

Страницы — подробно

Метод	Путь	Что делает
POST	/pages/markdown	опубликовать или обновить страницу из markdown с frontmatter
GET	/pages	список страниц с фильтрами и разбивкой
GET	/pages/{ref}	страница целиком: паспорт, родители, переводы, frontmatter, мета, тело в markdown
GET	/pages/{ref}/markdown	только тело в markdown — формат публикации
PATCH	/pages/{ref}	поменять выдержку и фрейм
DELETE	/pages/{ref}	в корзину или безвозвратно, с поддеревом, план без изменений
POST	/pages/language	проставить язык страницам без языка

Переводы — подробно

Метод	Путь	Что делает
GET	/pages/{ref}/translations	группа переводов страницы
PUT	/pages/{ref}/translations	положить группу целиком
POST	/pages/{ref}/translations/{lang}	добавить один перевод
DELETE	/pages/{ref}/translations	вывести страницу из группы

Фреймы — подробно

Метод	Путь	Что делает
GET	/frames	список фреймов
POST	/frames	загрузить фрейм
GET	/frames/{ref}	фрейм с разметкой
PUT	/frames/{ref}	заменить разметку (и слаг)
PATCH	/frames/{ref}	переименовать
DELETE	/frames/{ref}	удалить и снять со страниц
POST	/frames/{ref}/assign	поставить фрейм на страницу или снять
POST	/frames/rebake	пересобрать фреймы вручную
любой	/frames/defaults, /frames/{ref}/default	сняты — 410 gone

Данные — подробно

Метод	Путь	Что делает
GET	/data	наборы сайта
GET	/data/sources	системные источники: что читается, что пишется
GET	/data/{name}	содержимое набора или источника
PUT	/data/{name}	положить набор; для системного источника — записать меню или главную
PATCH	/data/{name}	точечная правка набора; для системного — настройки или язык
DELETE	/data/{name}	удалить набор или вариант языка
POST	/data/resolve	разрешить источник так, как это сделает повторитель

Меню — подробно

Метод	Путь	Что делает
GET	/menus	меню сайта и их области
POST	/menus	создать меню, сразу поставить и наполнить
PATCH	/menus/{ref}	переименовать
DELETE	/menus/{ref}	удалить с пунктами, освободить области
PUT	/menus/{ref}/location	поставить в область темы
PUT	/menus/{ref}/items	положить дерево пунктов
POST	/menus/{ref}/items	добавить пункт
PATCH	/menus/{ref}/items/{id}	поправить пункт
DELETE	/menus/{ref}/items/{id}	удалить пункт с веткой
POST	/menus/{ref}/reorder	порядок пунктов одного уровня

Сайдбар документации — подробно

Метод	Путь	Что делает
GET	/docs/sidebar	дерево
PUT	/docs/sidebar	положить дерево целиком
POST	/docs/sidebar/reorder	порядок в ветке
PATCH	/docs/sidebar/items/{ref}	перенести, переименовать, статус, скрыть
POST	/docs/sidebar/items/{ref}/hide	спрятать пункт
POST	/docs/sidebar/items/{ref}/show	вернуть пункт

Стили — подробно

Метод	Путь	Что делает
GET	/css	собственный CSS сайта и его опись
PUT, POST	/css	заменить CSS целиком
DELETE	/css	удалить CSS
GET	/design	токены дизайна
PATCH	/design	поменять токены
DELETE	/design	вернуть умолчания

Настройки, главная, кэш — подробно

Метод	Путь	Что делает
GET	/settings	настройки сайта
PATCH	/settings	название, описание, видимость, иконка, счётчики
PUT	/front-page	главная страница
POST	/cache/flush	сбросить кэши

Языки — подробно

Метод	Путь	Что делает
GET	/languages	языки и настройки Polylang
POST	/languages	добавить язык
PATCH	/languages	настройки адресов языков
PUT	/languages/default	язык по умолчанию
GET	/languages/{lang}	один язык
PATCH	/languages/{lang}	изменить язык
DELETE	/languages/{lang}	удалить язык

SEO — подробно

Метод	Путь	Что делает
GET	/seo	SEO-настройки сайта
PATCH	/seo	изменить их
GET	/seo/pages	обойти страницы и найти проблемы

Медиа — подробно

Метод	Путь	Что делает
POST	/media	загрузить файл
GET	/media	медиатека; поиск по источнику или хешу
GET	/media/{id}	одно вложение

Пользователи и профиль — подробно

Метод	Путь	Что делает
GET	/users	пользователи и приглашения сайта
POST	/users	добавить по почте
DELETE	/users/{id}	снять с сайта или отменить приглашение
GET	/me (сеть)	свой профиль
PATCH	/me (сеть)	имя, почта, язык дашборда
POST	/me/api-token (сеть)	выпустить токен заново
DELETE	/me/api-token (сеть)	отозвать токен

Сайты — подробно

Метод	Путь	Что делает
POST	/sites	создать сайт клоном (суперадмин)
GET	/sites/{id}	карточка сайта и site_id
POST	/sites/{id}/domain	назначить или обменять домен (суперадмин)
DELETE	/sites/{id}	архив или удаление (суперадмин)
POST	/sites/{id}/restore	вернуть из архива (суперадмин)

Вход и служебное — подробно

Метод	Путь	Что делает
GET	/health	жив ли сервис и база, какой контур
POST	/auth/session	ID-токен Firebase → сессия дашборда
POST	/auth/refresh	продлить сессию
POST	/auth/logout	выйти на этом устройстве
POST	/auth/logout-all	выйти везде
GET	/auth/me	состояние сессии
POST	/auth/ticket	билет для первой версии API

Всего 87 маршрутов. Ответ на несуществующий маршрут — 404 not_found. Все коды отказов — в таблице кодов.