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-mintMiddleware есть: без валидного токена сервер создаёт гостевой
optionalMiddleware есть, путь в publicRoutes: без токена не mint и не 401

Тела запросов и ответы: auth, catalog, cart, checkout, customer.

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/getнетГостевой / текущий 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Отмена

ЛК-эндпоинты с auto-mint требуют покупателя в токене: иначе контроллер вернёт unauthorized / business error. См. Клиент.

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}нетWebhook провайдера (подпись, не customer token)
GET/payment/get/{id}нетСпособ оплаты
GET/payment/listнетАктивные оплаты

Health

МетодПутьТокенНазначение
GET/healthнетСтатус API

Программное создание заказа из PHP (cron/extra) это не Web HTTP: ProgrammaticOrderService.