Настройки сайта
API читает и меняет настройки сайта и назначает главную страницу. Сценарии — в гайде.
API — https://onpress.pro/api/v2, SITE — id сайта, OP_TOKEN — токен op_XXXX. Пути на этой странице начинаются с $API/site/$SITE. Токен и права — в «Авторизации», общий формат — в «Общих правилах».
Эндпоинты
| Метод | Путь | Действие |
|---|---|---|
| GET | /data/site.settings | Прочитать настройки сайта |
| PATCH | /data/site.settings | Изменить настройки сайта |
| GET | /data/settings | Прочитать поля настроек |
| GET | /data/settings/{field} | Прочитать поле настроек |
| PUT | /data/settings/{field} | Изменить поле настроек |
| GET | /data/site.front_page | Прочитать главную страницу |
| PUT | /data/site.front_page | Назначить главную страницу |
Прочитать настройки сайта
GET /data/site.settings
Отдает настройки сайта одной записью в items. Подробнее в гайде.
curl -s -H "Authorization: Bearer $OP_TOKEN" "$API/site/$SITE/data/site.settings"
Параметров строки запроса и тела нет.
Ответ
{
"success": true,
"site_id": "x9HTLHECq",
"name": "site.settings",
"origin": "system",
"writable": true,
"write": { "method": "PATCH", "at": "/data/site.settings", "…": "…" },
"total": 1,
"items": [{
"name": "Test",
"description": "",
"home_url": "https://test.onpress.pro",
"site_url": "https://test.onpress.pro",
"admin_email": "admin@example.com",
"timezone": "UTC-5",
"date_format": "d.m.Y",
"time_format": "H:i",
"locale": "en_US",
"charset": "UTF-8",
"posts_per_page": 12,
"blog_public": 1,
"show_on_front": "page",
"front_page_id": 5776,
"posts_page_id": 0,
"theme": "onpress-v2"
}]
}
| Поле | Тип | Описание |
|---|---|---|
name | string | название сайта |
description | string | описание сайта; идет в разметку WebSite |
home_url, site_url | string | адрес сайта без косой черты на конце |
admin_email | string | почта администратора |
timezone | string | часовой пояс: имя зоны или UTC+N |
date_format, time_format | string | форматы даты и времени |
locale | string | локаль сайта |
charset | string | кодировка |
posts_per_page | number | сколько элементов на странице списка |
blog_public | number | 1 — сайт открыт поисковикам, 0 — закрыт |
show_on_front, front_page_id, posts_page_id | string, number | что открывается в корне: page и id страницы или posts |
theme | string | тема сайта |
Иконки в этой записи нет: ее отдает GET /data/settings/icon.
Ошибки
Общие коды — на странице «Ошибки».
Изменить настройки сайта
PATCH /data/site.settings
Меняет только присланные поля, остальные остаются как были. Подробнее в гайде.
curl -s -X PATCH "$API/site/$SITE/data/site.settings" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"description": "Бесплатный ИИ-чат без регистрации"}'
Тело запроса
| Поле | Тип | Обязательное | По умолчанию | Описание |
|---|---|---|---|---|
name | string | нет | — | название; пустая строка — отказ |
description | string | нет | — | описание сайта |
blog_public | 0/1 или bool | нет | — | открыт ли сайт поисковикам |
site_icon | int | нет | — | id картинки медиатеки этого сайта; 0 снимает иконку |
analytics | object | нет | — | ключи счетчиков как есть: ym_counter_id, ym_enabled, ym_counter_name, ga_measurement_id, ga_property_id, ga_property_name, ga_enabled, gsc_verification_token, gsc_site_url, gsc_verified, ywm_host_id, ywm_site_url, ywm_verification_token, ywm_verified, ywm_client_* (только чтение). Подключать счетчики проще полями metrika, ga, gsc и webmaster — см. Аналитика |
Ответ
{
"success": true,
"site_id": "x9HTLHECq",
"changed": ["description"],
"settings": { "name": "Test", "description": "Бесплатный ИИ-чат без регистрации", "blog_public": 1, "site_icon": 4827, "site_icon_url": "https://test.onpress.pro/…/icon.png", "analytics": { "…": "…" }, "domain": "test.onpress.pro", "show_on_front": "page", "page_on_front": 5776, "…": "…" },
"cache": { "object": true, "supercache": { "status": "flushed" }, "…": "…" },
"source": "site.settings",
"rebaked": { "status": "ok", "total": 15, "baked": 15, "frames": ["…"] }
}
changed — записанные поля, settings — настройки после записи, cache — сброс кэшей, rebaked — пересборка фреймов, которые печатают название, иконку или адрес сайта. Проверки без записи у этого эндпоинта нет: dry_run — отказ.
Ошибки
| Код | HTTP | Когда | Что делать |
|---|---|---|---|
nothing_to_change | 400 | в теле нет ни одного поля | пришлите хотя бы одно поле |
unknown_field | 400 | поле вне списка; допустимые — в message | уберите поле |
field_belongs_elsewhere | 400 | поле только читается здесь: show_on_front, front_page_id, posts_page_id, locale, home_url, site_url, theme; куда идти — в fields | главная — PUT /data/site.front_page, язык — PATCH /data/site.languages, адрес — свой домен PUT /data/domain; тему API не меняет |
invalid_name, invalid_description | 400 | не строка | пришлите строку |
invalid_site_icon | 400 | не целое число или такой картинки на сайте нет | возьмите id из GET /media |
invalid_analytics | 400 | analytics не объект или незнакомый ключ; допустимые — в allowed | исправьте ключи |
secret_field | 400 | в analytics прислан секрет, например ywm_client_token; имена в fields | секрет ставит вход в Вебмастер из консоли, снимает PUT /data/settings/webmaster с null |
dry_run_not_supported | 400 | прислан dry_run | прочитайте текущее значение через GET |
wrong_method_for_source | 405 | PUT вместо PATCH | отправьте PATCH |
system_source_not_deletable | 409 | DELETE | настройки не удаляются, только меняются |
internal_unavailable | 502 | сайт не ответил | повторите запрос |
Прочитать поля настроек
GET /data/settings
Отдает основные настройки по полям: у каждого поля свое значение и свой адрес записи. Подробнее в гайде.
curl -s -H "Authorization: Bearer $OP_TOKEN" "$API/site/$SITE/data/settings"
Параметров строки запроса и тела нет.
Ответ
{
"success": true,
"site_id": "x9HTLHECq",
"settings": {
"name": "Test",
"icon": 4827,
"closed": false,
"front_page": 5776,
"languages": [
{ "slug": "en", "locale": "en_US", "name": "English", "default": true, "front_page": 5776, "url": "https://test.onpress.pro/" },
{ "slug": "ru", "locale": "ru_RU", "name": "Русский", "default": false, "front_page": 6037, "url": "https://test.onpress.pro/ru/" }
],
"metrika": "12345678",
"ga": "G-XXXXXXX",
"gsc": null,
"webmaster": null
},
"details": {
"icon": { "url": "https://test.onpress.pro/…/icon.png" },
"closed": { "supported": true, "reason": null, "retry_after": 3600 },
"front_page": { "show_on_front": "page", "title": "home", "url": "/", "languages": { "en": 5776, "ru": 6037 } },
"languages": { "default": "en" },
"metrika": { "enabled": true, "name": "Test", "open_url": "https://metrika.yandex.ru/dashboard?id=12345678", "auto_available": true, "data": null },
"…": "…"
},
"fields": { "name": { "method": "PUT", "at": "/data/settings/name", "body": "{\"value\": …}", "forwards_to": "PATCH /data/site.settings {\"name\"}" }, "…": "…" }
}
settings — поле и его значение, details — что прилагается к значению, fields — как поле пишется. Одно поле — GET /data/settings/{field}: ответ field, value, поля из details и write.
| Поле | value при чтении | Рядом |
|---|---|---|
name | название сайта | — |
icon | id картинки, 0 — иконки нет | url |
closed | true — сайт закрыт для посетителей; null, если режим недоступен | supported, reason (not_v2, main_site), retry_after |
front_page | id главной, 0 — в корне лента записей | show_on_front, title, url, languages — {язык: id} главной каждого языка |
languages | [{slug, locale, name, default, front_page, url}], только чтение | default |
metrika, ga, gsc, webmaster | номер счетчика, measurement ID, код тега, id сайта в Вебмастере | см. Аналитика |
Ошибки
| Код | HTTP | Когда | Что делать |
|---|---|---|---|
unknown_settings_field | 404 | такого поля нет; список — в fields | возьмите поле из списка |
wrong_method_for_settings | 405 | метод, кроме GET и PUT, или PUT /data/settings без поля | пишите по одному полю |
Прочитать поле настроек
GET /data/settings/{field}
Возвращает значение одного поля и сведения о его записи. Подробнее в гайде.
curl -s "$API/site/$SITE/data/settings/name" -H "Authorization: Bearer $OP_TOKEN"
Параметры пути
| Поле | Тип | Обязательное | По умолчанию | Описание |
|---|---|---|---|---|
field | string | да | — | Идентификатор ресурса. |
Параметров строки запроса и тела нет.
field — name, icon, closed, front_page, languages, metrika, ga, gsc, webmaster.
Ответ
{"success":true,"site_id":"SITE_ID","field":"name","value":"Example","write":{"method":"PUT","at":"/data/settings/name","body":"{\"value\": …}"}}
Поля ответа — field, value, write и дополнительные сведения поля из списка настроек.
Ошибки
| Код | HTTP | Когда | Что делать |
|---|---|---|---|
unknown_settings_field | 404 | Поля нет. | Возьмите имя из списка. |
Изменить поле настроек
PUT /data/settings/{field}
Записывает одно поле телом {"value": …}. Подробнее в гайде.
curl -s -X PUT "$API/site/$SITE/data/settings/closed" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"value": true}'
Параметры пути
| Поле | Тип | Обязательное | По умолчанию | Описание |
|---|---|---|---|---|
field | string | да | — | Идентификатор ресурса. |
Дополнительных полей строки запроса нет.
Тело запроса
| Поле | Тип | Обязательное | По умолчанию | Описание |
|---|---|---|---|---|
value | string, number, boolean или null | да | — | Значение выбранного поля. Допустимые значения — в таблице ответа ниже. |
lang | string | нет | — | Язык страницы для поля front_page. |
Ответ
{
"success": true,
"site_id": "x9HTLHECq",
"field": "closed",
"value": true,
"supported": true,
"reason": null,
"retry_after": 3600,
"write": { "method": "PUT", "at": "/data/settings/closed", "…": "…" },
"changed": true,
"cache": { "…": "…" },
"forwards_to": "the closed mode of the site, through the executor of the site settings",
"rebaked": { "status": "ok", "…": "…" }
}
| Поле | Что принимает value |
|---|---|
name | непустая строка, пробелы по краям срезаются |
icon | id картинки медиатеки этого сайта; 0 или null снимает иконку. Иконка — это favicon и логотип организации в разметке |
closed | true закрывает сайт, false открывает |
front_page | id или путь опубликованной страницы; на многоязычном сайте рядом с value — lang, язык страницы |
metrika, ga, gsc, webmaster | см. Аналитика |
Ответ — поле после записи в форме чтения, плюс changed — изменилось ли что-то, cache, forwards_to — эндпоинт или исполнитель, который сделал запись, и rebaked: фреймы, которые печатают название, иконку или главную, пересобираются; при changed: false — rebaked.status: "nothing". Поле languages здесь только читается, языки меняет PATCH /data/site.languages.
Закрытый сайт отвечает посетителям 503 с заглушкой «сайт на обслуживании», Retry-After: 3600 и X-Robots-Tag: noindex; robots.txt отдает Disallow: /, карты сайта отвечают 503, llms.txt — 404, статические копии страниц снимаются, кэш сбрасывается. Вошедший администратор и API видят сайт как обычно. Свой robots.txt сохраняется и возвращается при открытии. Для сайта без поддержки режима API возвращает not_supported.
Ошибки
| Код | HTTP | Когда | Что делать |
|---|---|---|---|
value_required | 400 | в теле нет value | пришлите {"value": …} |
invalid_name | 400 | пустое название или не строка | пришлите непустую строку |
invalid_icon | 400 | не целое неотрицательное число | пришлите id картинки |
invalid_site_icon | 400 | картинки с таким id на сайте нет | возьмите id из GET /media |
invalid_closed | 400 | не да/нет | пришлите true или false |
invalid_front_page | 400 | пусто или 0 | пришлите id или путь страницы |
invalid_lang | 400 | неверный lang | возьмите слаг из GET /data/site.languages |
page_not_found | 404 | страницы нет | проверьте id или путь |
unknown_settings_field | 404 | такого поля нет | возьмите поле из GET /data/settings |
field_written_elsewhere | 405 | запись в languages | языки — PATCH /data/site.languages |
not_supported | 409 | closed на сайте без поддержки режима | — |
main_site | 409 | closed на главном сайте сети | — |
page_not_published | 409 | главной делают черновик | опубликуйте страницу |
no_default_translation | 409 | у страницы нет перевода на основной язык | привяжите перевод через PATCH /data/translations |
Прочитать главную страницу
GET /data/site.front_page
Возвращает текущую главную страницу одной записью. Подробнее в гайде.
curl -s "$API/site/$SITE/data/site.front_page" -H "Authorization: Bearer $OP_TOKEN"
Параметров строки запроса и тела нет.
Ответ
{"success":true,"site_id":"SITE_ID","name":"site.front_page","origin":"system","total":1,"items":[{"id":5776,"title":"Главная","slug":"home","status":"publish","show_on_front":"page","url":"/","real_url":"/home/"}]}
items[0] содержит id, show_on_front, title, slug, status, url и real_url. url равен /, real_url — собственный адрес страницы.
Ошибки
Общие коды — на странице «Ошибки».
Назначить главную страницу
PUT /data/site.front_page
Главная страница сайта: что открывается в корне. Подробнее в гайде.
curl -s -X PUT "$API/site/$SITE/data/site.front_page" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"page": 5776}'
Тело запроса
| Поле | Тип | Обязательное | По умолчанию | Описание |
|---|---|---|---|---|
page | int или string | да | — | id или путь страницы, обязательно; принимается и {"items": [{"id": …}]} из ответа чтения |
lang | string | нет | — | язык страницы, если путь есть в нескольких языках |
Ответ
PUT ставит главной страницу по id или пути; на многоязычном сайте вместе с ней переезжают главные всех языков — это ее переводы.
{
"success": true,
"site_id": "x9HTLHECq",
"changed": false,
"show_on_front": "page",
"page_on_front": 5776,
"front_pages": {
"en": { "id": 5776, "url": "https://test.onpress.pro/" },
"ru": { "id": 6037, "url": "https://test.onpress.pro/ru/" }
},
"before": { "show_on_front": "page", "page_on_front": 5776 },
"cache": { "…": "…" },
"source": "site.front_page",
"rebaked": { "status": "ok", "…": "…" }
}
GET отдает одну запись: id, show_on_front, title, slug, status, url (всегда /) и real_url — собственный адрес страницы. На многоязычном сайте записывается страница основного языка из группы переводов присланной, главные остальных языков — ее переводы (front_pages). Главная языка, у которой еще нет перевода, привязывается через PATCH /data/translations. Проверки без записи нет.
Ошибки
| Код | HTTP | Когда | Что делать |
|---|---|---|---|
invalid_page | 400 | нет page или пустой путь | пришлите id или путь |
invalid_lang | 400 | неверный lang | возьмите слаг из GET /data/site.languages |
dry_run_not_supported | 400 | прислан dry_run | — |
page_not_found | 404 | страницы нет | проверьте id или путь |
wrong_method_for_source | 405 | PATCH вместо PUT | отправьте PUT |
no_default_translation | 409 | у страницы нет перевода на основной язык | привяжите перевод |
page_not_published | 409 | страница не опубликована | опубликуйте ее |
Статистика контента
Сводку Google Analytics 4 отдает GET /data/content_stats.