Обзор конечных точек
Таблица ниже соответствует публичным маршрутам, подключённым в backend-public-api/app.js. Пути показаны с префиксом публичного прокси, используемым внешними интеграциями.
| Метод | Конечная точка | Описание | Доступ |
|---|---|---|---|
GET | /public-api/healthz | Проверка работоспособности сервиса. | публичный |
GET | /public-api/v1/auth/check | Проверяет учётные данные и возвращает магазин, права доступа и возможности тарифа. | любые аутентифицированные учётные данные |
GET | /public-api/v1/customer-orders | Возвращает список заказов покупателей с разбивкой на страницы и фильтрами. | orders:read |
GET | /public-api/v1/customer-orders/:id | Возвращает отдельный заказ покупателя с настроенными товарными позициями. | orders:read |
POST | /public-api/v1/customer-orders/batch | Возвращает до 100 заказов по ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Обновляет статус заказа. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Обновляет количество выбранных позиций заказа. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Устанавливает одинаковое количество для каждой позиции заказа. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Удаляет заказ покупателя, принадлежащий владельцу магазина. | orders:write |
GET | /public-api/v1/products | Возвращает товары/дизайны магазина с доступностью встраивания и URL медиафайлов. | products:read |
GET | /public-api/v1/products/:id | Возвращает один товар/дизайн магазина. | products:read |
POST | /public-api/v1/embed/session | Выдаёт краткосрочный JWT для встроенных инструментов, включая генератор моделей. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Определяет контекст среды выполнения по JWT встраивания. | токен встраивания Bearer |
GET | /public-api/v1/assets | Возвращает список ресурсов каталога запрошенного типа. | любые аутентифицированные учётные данные |
GET | /public-api/v1/assets/:type/:assetId | Возвращает манифест ресурса с ролями скачиваемых файлов. | любые аутентифицированные учётные данные |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Скачивает файл ресурса по роли. | любые аутентифицированные учётные данные |
GET | /public-api/v1/design-imports | Возвращает список доступных для импорта дизайнов, хранящихся в Alter. | аутентифицированные учётные данные, требуется тариф Business |
GET | /public-api/v1/design-imports/:id | Возвращает данные импорта дизайна и описания файлов. | аутентифицированные учётные данные, требуется тариф Business |
GET | /public-api/v1/design-imports/:id/files/:fileId | Скачивает файл по описанию импорта дизайна. | аутентифицированные учётные данные, требуется тариф Business |
GET | /public-api/v1/file/public/products/:productId/:size | Возвращает публичный предпросмотр товара. Размер должен быть small.png, medium.png или big.png. | публичный |
GET | /public-api/v1/file/protected/:key | Возвращает защищённый файл по ключу хранилища. | подписанный URL или files:read |
GET | /public-api/v1/fonts | Возвращает все доступные шрифты. | публичный |
GET | /public-api/v1/currencies | Возвращает все валюты. | публичный |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Создаёт или обновляет привязки среды выполнения по сопоставлениям товаров WordPress. | любые аутентифицированные учётные данные |
PATCH | /public-api/v1/runtime-bindings/:id | Изменяет привязку среды выполнения. | любые аутентифицированные учётные данные |
POST | /public-api/v1/runtime-bindings/:id/activate | Активирует привязку среды выполнения. | любые аутентифицированные учётные данные |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Деактивирует привязку среды выполнения. | любые аутентифицированные учётные данные |
POST | /public-api/v1/wp-connect/exchange | Обменивает код передачи автоматического подключения WordPress на учётные данные API. | одноразовый код передачи |
GET | /public-api/v1/model-generator/catalog | Выводит доступные для просмотра товары генератора, конфигурации и ревизии шаблонов. | embed:session:create |
GET | /public-api/v1/model-generator/models | Выводит модели с дескрипторами, фиксирующими исходные ревизии генератора для импорта. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Возвращает каталог моделей генератора, используемый Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Выводит проекты генератора владельца и глобально доступные проекты. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Возвращает последнюю или выбранную ревизию проекта, шаблон и манифест файлов. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Возвращает последнюю или выбранную ревизию проекта, шаблон и манифест файлов. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Загружает артефакт после проверки доступа к его проекту. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Возвращает доступный документ шаблона для выбранной ревизии конфигурации. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Возвращает пакет импорта шаблона с файлами зависимостей. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Возвращает оба манекена и дескрипторы их ресурсов. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Выводит ресурсы библиотеки текстур или фонов с файлами для импорта. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Возвращает один ресурс текстуры или фона с файлами для импорта. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Загружает разрешённый файл зависимости генератора. | embed:session:create |