Перейти к основному содержимому

Карта API

Общие правила

  • Базовый префикс: /api/v2/storefront.
  • Public endpoints возвращают только published/indexable данные.
  • Editorial endpoints требуют authenticated actor и permission.
  • Все write endpoints принимают Idempotency-Key, если могут повторяться.
  • Preview endpoints не кешируются публичным CDN.
  • Public form endpoints rate-limited и защищены spam policy.
  • Ошибки возвращаются в общем API envelope.

Public API

EndpointМетодPermissionНазначение
/pages/{slug}GETpublicопубликованная страница
/catalog/itemsGETpublicкаталог, фильтры, сортировка
/catalog/items/{slug}GETpublicкарточка каталога
/collections/{slug}GETpublicопубликованная подборка
/profiles/{slug}GETpublicпубличный профиль
/reviewsGETpublicопубликованные отзывы
/achievementsGETpublicопубликованные достижения
/factsGETpublicопубликованные факты
/forms/{formKey}/submissionsPOSTpublic rate-limitedзаявка
/sitemap.xmlGETpublicsitemap
/redirects/resolveGETpublic/internal edgeresolve redirect

Pages и CMS

EndpointМетодPermissionНазначение
/admin/pagesGET/POSTstorefront.pages.read/manageсписок и создание страниц
/admin/pages/{pageId}GET/PATCHstorefront.pages.read/manageкарточка страницы
/admin/pages/{pageId}/versionsGET/POSTstorefront.pages.read/manageверсии
/admin/page-versions/{versionId}/blocksPOSTstorefront.pages.manageдобавить блок
/admin/blocks/{blockId}PATCH/DELETEstorefront.pages.manageизменить блок
/admin/page-versions/{versionId}/previewGETstorefront.preview.readpreview
/admin/page-versions/{versionId}/publishPOSTstorefront.pages.publishпубликация

Catalog

EndpointМетодPermissionНазначение
/admin/catalog/itemsGET/POSTstorefront.catalog.read/manageкарточки
/admin/catalog/items/{itemId}GET/PATCHstorefront.catalog.read/manageкарточка
/admin/collectionsGET/POSTstorefront.collections.read/manageподборки
/admin/collections/{collectionId}/itemsPOSTstorefront.collections.manageдобавить item
/admin/collections/{collectionId}/publishPOSTstorefront.collections.publishпубликация

Profiles, reviews, achievements, facts

EndpointМетодPermissionНазначение
/admin/profilesGET/POSTstorefront.profiles.read/manageпрофили
/admin/profiles/{profileId}GET/PATCHstorefront.profiles.read/manageкарточка профиля
/admin/reviewsGET/POSTstorefront.reviews.read/manageотзывы
/admin/reviews/{reviewId}/moderatePOSTstorefront.moderation.managemoderation decision
/admin/achievementsGET/POSTstorefront.achievements.read/manageдостижения
/admin/achievements/{achievementId}/moderatePOSTstorefront.moderation.managemoderation decision
/admin/factsGET/POSTstorefront.facts.read/manageфакты
/admin/facts/{factId}/verifyPOSTstorefront.facts.verifyпроверка факта

Campaigns, forms, SEO

EndpointМетодPermissionНазначение
/admin/campaignsGET/POSTstorefront.campaigns.read/manageкампании
/admin/formsGET/POSTstorefront.forms.read/manageформы
/admin/form-submissionsGETstorefront.forms.read_submissionsзаявки
/admin/form-submissions/{id}/retry-crmPOSTstorefront.forms.manageповторная отправка в CRM
/admin/redirectsGET/POSTstorefront.seo.read/manageredirects
/admin/redirects/{id}PATCH/DELETEstorefront.seo.manageизменить redirect
/admin/sitemap/rebuildPOSTstorefront.seo.manageпересобрать sitemap
/admin/audit-logsGETstorefront.audit.readaudit

Error codes

КодHTTPКогда
storefront.page.not_found404page не найдена или не опубликована
storefront.page.not_publishable409version нельзя опубликовать
storefront.block.invalid400block props/data source невалидны
storefront.catalog.source_required400item без source/manual owner
storefront.moderation.required409entity требует moderation
storefront.consent.required409нет согласия на публикацию
storefront.fact.not_verified409факт не проверен
storefront.form.rate_limited429превышен rate limit
storefront.form.spam_rejected400spam policy отклонила заявку
storefront.redirect.unsafe400open redirect или цикл