docs.modx.pro
  1. Компоненты
  2. MiniShop3
  3. Разработка
  4. Web API
  5. Справка

Web API ​

Точка входа витрины и headless:

text
/assets/components/minishop3/api.php?route=/api/v1/{path}

Параметр route обязателен. Группа /api/v1 всегда проходит три middleware: CORS → RateLimit → ServiceCheck. TokenMiddleware вешается не на всю группу, а на cart, order и часть customer.

Manager API (connector.php) на этой странице не описан.

Envelope ​

Успех:

json
{
  "success": true,
  "message": "",
  "data": {}
}

Ошибка:

json
{
  "success": false,
  "message": "…",
  "code": 400,
  "errors": null,
  "error_code": "bad_request"
}

Ключ errors в теле ошибки есть всегда (часто null). error_code резолвится на сервере. Подробнее: Ошибки.

Middleware ​

ПорядокMiddlewareНазначение
1CorsMiddlewareOrigins из ms3_cors_allowed_origins
2RateLimitMiddlewarems3_rate_limit_*
3ServiceCheckMiddlewareСервисы MS3 доступны
(по роуту)TokenMiddlewareResolve / auto-mint токена

Настройки CORS и rate limit: CORS, Системные настройки.

Разделы ​

  1. Авторизация
  2. Карта эндпоинтов
  3. Каталог
  4. Корзина
  5. Checkout
  6. Клиент
  7. Ошибки
  8. CORS и rate limit
  9. Примеры

Кастомные роуты и детали FastRoute: API Router.