Skip to content
  1. Компоненты
  2. MiniShop3
  3. Разработка
  4. Web API
  5. Карта эндпоинтов

Карта эндпоинтов ​

Источник таблиц: core/components/minishop3/config/routes/web.php. Все пути идут с префиксом /api/v1, вызов — api.php?route=/api/v1/....

Значения колонки «Токен»:

ЗначениеСмысл
нетTokenMiddleware на роуте нет
auto-mintTokenMiddleware есть: без валидного токена сервер создаёт гостевой
optionalTokenMiddleware есть, путь в publicRoutes: без токена сервер не создаёт гостевой токен и не отвечает 401

Тела запросов и форматы ответов разобраны на тематических страницах: Авторизация, Каталог, Корзина, Checkout, Клиент.

Cart ​

МетодПутьТокенНазначение
POST/cart/addauto-mintДобавить товар
POST/cart/removeauto-mintУдалить позицию
POST/cart/changeauto-mintИзменить количество
POST/cart/change-optionauto-mintИзменить опции позиции
GET/cart/getauto-mintСодержимое корзины
POST/cart/cleanauto-mintОчистить

Order ​

МетодПутьТокенНазначение
GET/order/getauto-mintЧерновик заказа
POST/order/addauto-mintОдно поле черновика
POST/order/setauto-mintНесколько полей
POST/order/removeauto-mintУдалить поле
POST/order/submitauto-mintОформить
POST/order/cleanauto-mintОчистить черновик
GET/order/costauto-mintПолная стоимость
GET/order/cost/cartauto-mintСтоимость корзины
GET/order/cost/deliveryauto-mintСтоимость доставки
GET/order/cost/paymentauto-mintКомиссия оплаты
POST/order/address/setauto-mintАдрес из сохранённых
POST/order/address/cleanauto-mintСбросить адрес черновика
GET/order/delivery/validation-rulesauto-mintПравила полей доставки
GET/order/delivery/required-fieldsauto-mintОбязательные поля

Customer ​

МетодПутьТокенНазначение
POST/customer/loginнетВход
POST/customer/registerнетРегистрация
GET/customer/meauto-mintСессия / профиль токена
POST/customer/logoutoptionalВыход
POST/customer/forgot-passwordнетЗапрос сброса
POST/customer/reset-passwordнетСброс по токену письма
POST/customer/addauto-mintБыстрое поле профиля
GET/customer/token/getoptionalГостевой / текущий API-токен
POST/customer/token/refreshauto-mintРотация токена
GET/customer/addressesauto-mintСписок адресов
GET/customer/addresses/{id}auto-mintОдин адрес
POST/customer/addressesauto-mintСоздать
PUT/customer/addresses/{id}auto-mintОбновить
DELETE/customer/addresses/{id}auto-mintУдалить
PUT/customer/addresses/{id}/set-defaultauto-mintАдрес по умолчанию
PUT/customer/profileauto-mintПрофиль
POST/customer/changeAddressauto-mintАдрес в черновик заказа
POST/customer/email/resend-verificationauto-mintПовтор письма
GET/customer/email/verifyнетПодтверждение email
GET/customer/ordersauto-mintЗаказы ЛК
GET/customer/orders/{id}auto-mintКарточка заказа
POST/customer/orders/{id}/cancelauto-mintОтмена

У адресов, профиля, customer/add, повторной отправки письма и заказов личного кабинета auto-mint работает, но сам запрос требует покупателя в токене.

Для гостя GET /customer/me и POST /customer/token/refresh отвечают успехом: у me будет authenticated: false и customer: null. Подробнее — Клиент.

Product (публичный) ​

МетодПутьТокенНазначение
GET/product/getнетResolve по alias / uri
GET/product/get/{id}нетТовар по ID
GET/product/listнетСписок товаров (PLP)
GET/product/filtersнетФасеты
GET/product/{id}/imagesнетГалерея

Category (публичный) ​

МетодПутьТокенНазначение
GET/category/getнетResolve по alias / uri
GET/category/get/{id}нетКатегория по ID
GET/category/listнетСписок
GET/category/treeнетДерево

Delivery / Payment (публичный) ​

МетодПутьТокенНазначение
GET/delivery/get/{id}нетСпособ доставки
GET/delivery/listнетАктивные доставки
POST/delivery/webhook/{delivery_id}нетВебхук доставки (подпись handler, при ms3_shipment_enabled=0 — 404)
GET/payment/get/{id}нетСпособ оплаты
GET/payment/listнетАктивные оплаты
POST/payment/webhook/{payment_method_id}нетВебхук оплаты (PaymentWebhookHandlerInterface)

Health ​

МетодПутьТокенНазначение
GET/healthнетПроверка доступности: status, version (ms3_version, иначе 1.0.0), timestamp, api: web

Программное создание заказа из PHP (cron, дополнение) к Web API не относится: ProgrammaticOrderService.