Справочник 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, /me/credits, /credits, /auth, /health, /frames/system — без префикса сайта.

{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 — формат публикации
GET	/pages/{ref}/export	JSON для перевода: страница, markdown, переводы, наборы фрейма, шапка, подвал и меню
PATCH	/pages/{ref}	поменять выдержку, фрейм, превью и HowTo
DELETE	/pages/{ref}	в корзину или безвозвратно, с поддеревом, план без изменений
POST	/pages/language	проставить язык страницам без языка
POST	/links/build	собрать ссылки из текста всех страниц и сохранить
GET	/links	ссылки всех страниц из последней сборки: анкор, контекст, цель, состояние, входящие
GET	/pages/{ref}/links	исходящие и входящие ссылки одной страницы
GET	/traffic	показы и клики Google и посетители Google Analytics по страницам за год
GET	/pages/{ref}/traffic	история трафика страницы по дням, неделям или месяцам, с датами правок
PUT, DELETE	/pages/{ref}/advice/{kind}	отметить рекомендацию страницы выполненной или снять отметку
GET	/markdown	состояние markdown-копий страниц (адреса с .md)
POST	/markdown/build	собрать копии всех публичных страниц и llms.txt

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

Метод	Путь	Что делает
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	пересобрать фреймы вручную
POST	/frames/{ref}/reset	сбросить свой фрейм к системному
GET	/frames/system	библиотека системных фреймов (ручка сети, без префикса сайта)
GET, PUT	/frames/system/{ref}	системный фрейм с разметкой; новая версия — только суперадмин
POST	/frames/system	сделать фрейм сайта системным — только суперадмин
любой	/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	/data/settings	поля «Основы»: название, иконка, видимость, режим «закрыт», главная, языки
GET, PUT	/data/settings/{field}	одно поле; запись — {"value": …}

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

Метод	Путь	Что делает
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-настройки сайта (Yoast)
PATCH	/seo	изменить их
GET, PATCH	/seo/app	карточка приложения — узел SoftwareApplication
POST	/seo/audit	проверить весь SEO-чеклист и сохранить итог
GET	/seo/audit	последний итог проверки
GET	/seo/pages	обойти страницы и найти проблемы
POST	/seo/links/check	запустить проверку ссылок
GET	/seo/links	ход или итог проверки ссылок
GET	/seo/link-graph	граф внутренних ссылок
GET, POST	/seo/index-status	статус страниц в Google
GET, PUT, DELETE	/robots	robots.txt сайта
GET, PUT, DELETE	/llms	llms.txt сайта
GET, POST	/llms/build	собрать llms.txt по страницам — ссылки на .md, все языки, дальше пересобирается сам
GET, POST	/indexnow	ключ IndexNow и отправка адресов
GET, PUT	/access	сайт открыт или закрыт

Редиректы — подробно

Метод	Путь	Что делает
GET	/redirects	правила редиректов сайта с поиском
POST	/redirects	завести правило: любой путь сайта → любой адрес
GET, PATCH, DELETE	/redirects/{id}	одно правило: прочитать, поправить, удалить
POST	/redirects/import	пакетный импорт CSV или JSON, пробный прогон
POST	/redirects/apply	отдать сайту набор правил заново
PUT	/redirects/auto	автоправила при переносе и удалении страниц: включить или выключить

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

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

Входящие — подробно

Метод	Путь	Что делает
GET	/inbox/threads	переписки: входящие, архив, непрочитанные, поиск
GET	/inbox/filters	ящики и счётчики
GET	/inbox/unread-count	число непрочитанных
POST	/inbox/read-all	отметить всё прочитанным
GET	/inbox/threads/{id}	переписка с письмами
PATCH	/inbox/threads/{id}	в архив или обратно, прочитано или нет
POST	/inbox/threads/{id}/reply	ответить письмом
POST	/inbox/uploads	загрузить вложение ответа
POST	/inbox/messages/{id}/retry	повторить неушедший ответ
GET	/inbox/sender	с какого адреса уйдёт ответ
GET	/inbox/settings	настройки ящика: имя отправителя, подпись, домены
PATCH	/inbox/settings	изменить имя отправителя и подпись
GET	/inbox/templates	шаблоны ответа
POST	/inbox/templates	создать шаблон ответа
PUT	/inbox/templates/{id}	изменить шаблон ответа
DELETE	/inbox/templates/{id}	удалить шаблон ответа

Кросспостинг — подробно

Метод	Путь	Что делает
GET	/crosspost	канал, проверка, разделы, лимиты
PUT	/crosspost/telegram	подключить канал, включить, выбрать разделы
POST	/crosspost/telegram/check	проверить, что бот может публиковать
POST	/crosspost/telegram/test	тестовый пост
DELETE	/crosspost/telegram	отключить канал
GET	/crosspost/log	журнал отправок
POST	/crosspost/log/{id}/send	отправить пропущенную страницу вручную

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

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

Кредиты и автоматизация — подробно

Метод	Путь	Что делает
GET	/me/credits (сеть)	баланс, прайс, пакеты пополнения, последние движения
GET	/me/credits/transactions (сеть)	история движений кредитов
POST	/me/credits/topup (сеть)	ссылка на оплату пакета кредитов
POST	/credits/grant (сеть)	начислить или скорректировать кредиты (суперадмин)
GET	/ai/prompts	промпты ИИ сайта
GET	/ai/prompts/{key}	один промпт
PUT	/ai/prompts/{key}	свой текст и модель промпта
DELETE	/ai/prompts/{key}	вернуть промпт к умолчанию
GET	/ai/jobs	задачи ИИ сайта
GET	/ai/jobs/{id}	одна задача с шагами и расходом
POST	/ai/jobs	поставить задачу ИИ (платно)
POST	/ai/jobs/{id}/cancel	снять задачу из очереди
GET	/integrations/github	подключение репозитория GitHub
PUT	/integrations/github	подключить или изменить: репозиторий, токен, режим, расписание
DELETE	/integrations/github	отключить
GET	/integrations/github/releases	релизы репозитория с отметкой о публикации
POST	/integrations/github/releases/publish	опубликовать выбранные релизы в чейнджлог
DELETE	/integrations/github/releases/{releaseId}	снять запись чейнджлога
POST	/integrations/github/sync	забрать новые релизы сейчас
GET	/integrations/github/history	журнал публикаций
GET	/news/auto	настройки автоновостей, цены, расписание
PUT	/news/auto	поменять настройки и расписание
POST	/news/auto/run	сделать новость сейчас (платно)
GET	/news/auto/items	сделанные новости, черновики и сбои
POST	/news/auto/items/{id}/publish	опубликовать черновик
DELETE	/news/auto/items/{id}	убрать черновик или сбой
POST	/news/auto/feed	пересобрать ленту новостей

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