Все пути даны относительно $BASE — базового адреса v2, в сети стенда это https://stagepress.bond/api/v2, см. Быстрый старт . Любой вызов, кроме GET /health, требует Authorization: Bearer $OP_TOKEN, см. Аутентификация . Сайт выбирается blog_id в теле или в строке запроса, заголовком X-OnPress-Blog-Id или domain; без них — главный сайт сети. Форма ошибок у всех ручек общая, см. Ошибки .
{ref} страницы — id, слаг или путь с ~ вместо /; {ref} фрейма — его id или слаг; {ref} меню — id, слаг, имя или @область.
Здоровье
Метод Путь Что делает Подробности GET /healthсервис жив и видит базу: {"ok": true, "db": true}, без базы — 503; токен не нужен Быстрый старт
Страницы
Метод Путь Что делает Подробности POST /pages/markdownсоздать или обновить страницу из markdown с frontmatter Страницы и markdown POST /pages/languageпроставить страницам язык Polylang: перечисленным или всем, у кого его нет Страницы и markdown
Переводы
Метод Путь Что делает Подробности GET /pages/{ref}/translationsгруппа переводов страницы Переводы PUT /pages/{ref}/translationsзаписать группу целиком Переводы POST /pages/{ref}/translations/{lang}добавить в группу один перевод Переводы DELETE /pages/{ref}/translationsвывести страницу из группы Переводы
Сайдбар документации
Фреймы
Метод Путь Что делает Подробности GET /framesфреймы сайта без разметки; ?block=, ?q=, ?include_html=1 Фреймы POST /framesзалить новый фрейм; dry_run проверяет без записи Фреймы GET /frames/{ref}один фрейм вместе с разметкой Фреймы PUT /frames/{ref}заменить разметку Фреймы PATCH /frames/{ref}поменять поля без разметки; новый слаг переписывает все ссылки op/frame Фреймы DELETE /frames/{ref}удалить фрейм и все привязки к нему Фреймы POST /frames/{ref}/assignпечатать страницу в этом фрейме Фреймы POST /frames/rebakeзаново испечь копии, зависящие от названного изменения Как это устроено любой /frames/defaults, /frames/{ref}/defaultсняты: 410 gone; фреймы связываются через op/frame Фреймы
Адреса у фрейма нет: url в теле POST, PUT или PATCH /frames — 400 frame_url_not_supported. Адреса принадлежат страницам, а лендинг — это страница с фреймом-оболочкой, см. Фреймы .
Данные
Метод Путь Что делает Подробности GET /dataнаборы данных сайта Данные GET /data/sourcesсистемные источники, только чтение Данные GET /data/{name}прочитать источник или набор Данные PUT /data/{name}записать набор целиком Данные PATCH /data/{name}операции над элементами набора Данные DELETE /data/{name}удалить набор Данные POST /data/resolveразрешить источник так же, как это сделает печать Данные
CSS сайта
Метод Путь Что делает Подробности GET /site/cssпроизвольный CSS сайта и запись о нём Стили PUT /site/cssзаменить CSS целиком Стили POST /site/cssто же, что PUT Стили DELETE /site/cssудалить CSS, вернуться к теме Стили
Токены дизайна
Метод Путь Что делает Подробности GET /site/designвсе токены со значением, значением по умолчанию и источником Стили PATCH /site/designзадать отдельные токены Стили DELETE /site/designвернуть значения темы по умолчанию Стили
Меню
Метод Путь Что делает Подробности 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перенумеровать один уровень Меню
Содержимое меню читается источниками данных menu.*, а не здесь.
Сайты и настройки
Метод Путь Что делает Подробности POST /sitesновый сайт клоном донора, при желании пустой; суперадмин сети Сайты и настройки GET /sites/{id}карточка сайта: домен, видимость, тема, главная, языки, объёмы Сайты и настройки GET /site/settingsназвание, подзаголовок, индексация, иконка, аналитика Сайты и настройки PATCH /site/settingsпоменять эти настройки; администратор сайта Сайты и настройки PUT /site/front-pageназначить статическую главную Сайты и настройки POST /site/cache/flushсбросить транзиенты, страничный и объектный кэш, кэши Polylang Сайты и настройки
Метод Путь Что делает Подробности POST /mediaзагрузить картинку по адресу или в base64; повтор безопасен Медиа GET /mediaнайти загрузку по ?source_url= или ?sha256= Медиа GET /media/{id}описание вложения Медиа
Чего в v2 нет
Страницы v2 не читает: список страниц и экспорт страницы в markdown — это v1, /wp-json/onpress/v1/, который принимает тот же op_-токен. Аппы, отчёты аналитики и почта — тоже v1.
