Справочник API

Здесь все эндпоинты API v2 одним списком по разделам справочника, а как начать работу с API — в быстром старте и на странице «Доступ и токен».

info

Во всех примерах API — https://onpress.pro/api/v2, SITE — id сайта (SITE_ID), OP_TOKEN — токен op_XXXX.

Как устроены адреса

Все запросы и ответы — JSON в UTF-8, токен передаётся заголовком Authorization: Bearer $OP_TOKEN. Эндпоинты сайта живут под /site/{siteId}: в таблицах ниже путь /pages означает $API/site/$SITE/pages. Эндпоинты сети — /sites, /me, /auth, /health и /frames/system — работают без префикса сайта, в таблицах они помечены «(сеть)». Как выбрать сайт, какие права нужны и какие лимиты действуют — в разделе «Авторизация», форма ответа и общие коды отказов — в разделе «Ошибки».

{ref} страницы — id, слаг или путь, где каждый слеш заменён тильдой: docs~v2~ru~data~ для /docs/v2/ru/guides/data/. {ref} фрейма — id или слаг. {ref} меню — id, слаг, имя или область с тильдой: ~header. Например, выгрузка страницы по пути:

curl -s "$API/site/$SITE/pages/docs~v2~ru~data~/markdown?lang=ru" \
  -H "Authorization: Bearer $OP_TOKEN"

Основы

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

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

Метод	Путь	Что делает
POST	/pages/markdown	опубликовать или обновить страницу из markdown со свойствами
GET	/pages	список страниц с фильтрами и разбивкой
GET	/pages/search	поиск по тексту всех страниц
GET	/pages/{ref}	страница целиком: паспорт, родители, переводы, свойства, тело в markdown
GET	/pages/{ref}/markdown	тело страницы в markdown — формат публикации
PATCH	/pages/{ref}/markdown	точечная правка текста: заменить фразу или раздел, поправить свойства
PATCH	/pages/{ref}	поменять выдержку, фрейм и превью
DELETE	/pages/{ref}	в корзину или безвозвратно, с поддеревом; dry_run — план без изменений
GET	/pages/{ref}/export	JSON для перевода: страница, markdown, переводы, данные фрейма
POST	/pages/import	принять переведённый экспорт обратно страницей
POST	/pages/series	несколько страниц одним запросом с публикацией по расписанию
GET	/pages/{ref}/data-fields	данные, которые фрейм страницы читает именно на ней
POST	/pages/language	проставить язык страницам без языка
GET	/pages/{ref}/related	кандидаты для внутренних ссылок на страницу
POST	/links/build	собрать ссылки из текста всех страниц и сохранить
GET	/links	ссылки всех страниц из последней сборки: анкор, контекст, цель, состояние
GET	/pages/{ref}/links	исходящие и входящие ссылки одной страницы
GET	/traffic	показы и клики Google и посетители Google Analytics по страницам за год
GET	/pages/{ref}/traffic	история трафика страницы по дням или неделям
PUT	/pages/{id}/keyword-frequency	записать частотность ключевого запроса страницы в Яндексе и Google
PUT, DELETE	/pages/{ref}/advice/{kind}	отметить рекомендацию страницы выполненной или снять отметку
GET, POST	/views	сохраненные представления списка страниц: прочитать, создать
PATCH, DELETE	/views/{id}	поправить или удалить сохраненное представление
POST	/sections/{section}	завести раздел сайта: news, changelog или docs
GET	/markdown	состояние markdown-копий страниц (адреса с .md)
POST	/markdown/build	собрать копии всех публичных страниц

Тело страницы можно читать и записывать и как данные: GET и PUT /data/pages.content.

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

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

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

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

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

Метод	Путь	Что делает
GET	/frames	список фреймов
POST	/frames	загрузить фрейм
GET	/frames/{ref}	фрейм с разметкой
PUT	/frames/{ref}	заменить разметку (и слаг)
PATCH	/frames/{ref}	поменять поля без замены разметки
DELETE	/frames/{ref}	удалить и снять со страниц
POST	/frames/{ref}/assign	поставить фрейм на страницу или снять
GET, PUT, PATCH, DELETE	/frames/{ref}/files/{name}	файлы фрейма: прочитать, записать, переименовать, удалить
GET	/frames/{ref}/preview	собранный фрейм целым HTML-документом
GET	/frames/{ref}/thumbnail	снимок фрейма в WebP
GET	/frames/thumbnails	состояние снимков всех фреймов
POST	/frames/rebake	пересобрать фреймы вручную
POST	/frames/{ref}/reset	сбросить свой фрейм к системному
POST	/frames/{ref}/detach	сделать системный фрейм своим на этом сайте
POST	/frames/{ref}/revert	вернуть системный фрейм вместо своего
GET	/frames/system (сеть)	библиотека системных фреймов
GET	/frames/system/{ref} (сеть)	системный фрейм с разметкой

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

Метод	Путь	Что делает
GET	/data	все данные сайта: пользовательские и системные
GET	/data/user	список пользовательских данных
GET	/data/system	список системных данных: что читается, что пишется и каким методом
GET	/data/{name}	содержимое данных
PUT	/data/{name}	записать данные целиком
PATCH	/data/{name}	точечная правка: {"patch": [{"action": …}]}
DELETE	/data/{name}	удалить пользовательские данные или их вариант на языке
POST	/data/resolve	получить данные так, как их получит фрейм на странице
GET	/data/settings	поля настроек: название, иконка, «закрыт», главная, языки, счётчики
GET, PUT	/data/settings/{field}	одно поле; запись — {"value": …}

Системные данные и методы записи:

Имя	Методы	Что это
menu.header, menu.footer_1, menu.footer_2, menu.footer_3	GET, PUT	пункты меню в области темы
site.settings	GET, PATCH	название, описание, адреса, часовой пояс
site.front_page	GET, PUT	главная страница
site.languages	GET, PATCH	языки сайта
site.locales	GET	языки, которые можно добавить
site.socials	GET, PATCH	ссылки на соцсети
site.organization	GET, PATCH	организация для поисковиков: название, контакты, адрес
css	GET, PUT, DELETE	собственный CSS сайта
css.variables	GET, PATCH, DELETE	CSS-переменные темы
pages.content	GET, PUT	тело страницы в markdown
pages.all, pages.tree, pages.top, pages.children, pages.siblings, pages.adjacent, breadcrumbs	GET	списки страниц и хлебные крошки для фреймов

Настройки сайта — подробно

Метод	Путь	Что делает
GET	/data/settings	все поля настроек с подробностями
PUT	/data/settings/{field}	name, icon, closed, front_page, metrika, ga, gsc, webmaster
GET, PATCH	/data/site.settings	название, описание и другие настройки
GET, PUT	/data/site.front_page	главная страница
GET, PATCH	/data/site.socials	ссылки на соцсети
GET, PATCH	/data/site.organization	организация для поисковиков
GET	/content-stats	посещаемость сайта по Google Analytics за вчера, неделю или месяц
POST	/cache/flush	сбросить кэш сайта целиком

После записи страницы её кэш сбрасывается сам, POST /cache/flush нужен только для сброса всего сайта.

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

Метод	Путь	Что делает
GET	/data/site.languages	языки сайта
PATCH	/data/site.languages	добавить, изменить, удалить язык, сменить язык по умолчанию
GET	/data/site.locales	языки, которые можно добавить
PATCH	/languages	настройки адресов языков

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

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

SEO — подробно

Метод	Путь	Что делает
GET, PATCH	/seo	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	/sitemap	карта сайта в Search Console и Вебмастере
GET	/sitemap/urls	адреса карты сайта
POST	/sitemap/submit	отправить карту в консоли поисковиков
GET, PUT, DELETE	/robots	robots.txt сайта
GET, PUT, DELETE	/llms	llms.txt сайта
GET, POST	/llms/build	собрать llms.txt по страницам: GET показывает итог без записи
GET, POST	/indexnow	ключ IndexNow и отправка адресов
GET, DELETE	/indexing/account	привязка бота быстрой индексации
GET	/indexing/pages	страницы и состояние их отправки
POST	/indexing/estimate	цена отправки в кредитах
POST	/indexing/submit	отправить страницы на быструю индексацию (платно)
GET	/indexing/submissions	журнал отправок
POST	/indexing/submissions/refresh	обновить состояние отправок
GET, PUT	/serp/settings	режим и расписание проверки позиций
PUT, DELETE	/serp/key	свой ключ SerpApi
GET, POST	/serp/queries	запросы для проверки позиций
POST	/serp/queries/sync	взять запросы из ключей страниц
DELETE	/serp/queries/{id}	снять запрос с историей
GET	/serp/queries/{id}/positions	история позиций
POST	/serp/queries/{id}/check	проверить позицию сейчас: за кредит или своим ключом
GET	/semantic	семантическое ядро сайта: группы и ключи
POST	/semantic/import, /semantic/sync	загрузить ключи, сверить группы со страницами
POST, PATCH, DELETE	/semantic/groups, /semantic/groups/{id}	группы ключей
PATCH, DELETE	/semantic/keywords/{id}	один ключ
POST	/semantic/groups/{id}/page	завести страницу под группу

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

Пункты меню в области темы читаются и записываются как данные: GET и PUT /data/menu.header. Остальное — эндпоинтами меню:

Метод	Путь	Что делает
GET	/menus	меню сайта и их области
POST	/menus	создать меню, сразу поставить и наполнить
PATCH	/menus/{ref}	переименовать
DELETE	/menus/{ref}	удалить с пунктами, освободить области
PUT	/menus/{ref}/location	поставить в область темы
DELETE	/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	/redirects	правила редиректов сайта с поиском
POST	/redirects	завести правило: любой путь сайта → любой адрес
GET, PATCH, DELETE	/redirects/{id}	одно правило: прочитать, поправить, удалить
POST	/redirects/import	пакетный импорт CSV или JSON, пробный прогон
POST	/redirects/apply	отдать сайту набор правил заново
PUT	/redirects/auto	автоправила при переносе и удалении страниц: включить или выключить

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

Метод	Путь	Что делает
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	/sites/plans (сеть)	тарифы для нового сайта
POST	/sites (сеть)	создать сайт по тарифу; платный тариф — 402 и ссылка на оплату
GET	/sites/orders/{id} (сеть)	состояние заказа сайта
GET	/sites/{id} (сеть)	карточка сайта и site_id
GET	/sites/{id}/custom-domain (сеть)	состояние своего домена
POST	/sites/{id}/custom-domain (сеть)	подключить свой домен
DELETE	/sites/{id}/custom-domain (сеть)	отменить подключение или вернуть прежний адрес

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

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

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

Метод	Путь	Что делает
GET	/me/credits (сеть)	баланс, прайс, пакеты пополнения, последние движения
GET	/me/credits/transactions (сеть)	история движений кредитов
POST	/me/credits/topup (сеть)	ссылка на оплату пакета кредитов
GET	/me/credits/topups/{id} (сеть)	состояние пополнения
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	пересобрать ленту новостей

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

Метод	Путь	Что делает
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}/read	отметить переписку прочитанной
POST	/inbox/threads/{id}/reply	ответить письмом
GET	/inbox/threads/{id}/messages/{mid}/html	письмо в HTML
GET	/inbox/messages/{id}/raw	исходник письма
GET	/inbox/attachments/{id}	вложение письма
POST	/inbox/uploads	загрузить вложение ответа
POST	/inbox/messages/{id}/retry	повторить неушедший ответ
GET	/inbox/sender	с какого адреса уйдёт ответ
GET, PATCH	/inbox/settings	имя отправителя и подпись
GET, POST	/inbox/templates	шаблоны ответа: список, создать
PUT, DELETE	/inbox/templates/{id}	изменить или удалить шаблон
POST	/inbox/templates/{id}/used	отметить, что шаблон использован

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

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

Несуществующий маршрут отвечает 404 not_found. Коды отказов по всем эндпоинтам — в таблице кодов.