Огляд кінцевих точок
Таблиця нижче відповідає публічним маршрутам, підключеним у 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 |