docs.modx.pro
  1. Extras
  2. MiniShop3
  3. Development
  4. Web API
  5. Reference

Web API ​

Storefront and headless entry point:

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

The route parameter is required. The /api/v1 group always runs three middleware layers: CORS → RateLimit → ServiceCheck. TokenMiddleware is not applied to the whole group; it is attached to cart, order, and part of customer.

Manager API (connector.php) is not documented on this page.

Envelope ​

Success:

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

Error:

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

The errors key is always present in error bodies (often null). error_code is resolved on the server. Details: Errors.

Middleware ​

OrderMiddlewarePurpose
1CorsMiddlewareOrigins from ms3_cors_allowed_origins
2RateLimitMiddlewarems3_rate_limit_*
3ServiceCheckMiddlewareMS3 services available
(per route)TokenMiddlewareResolve / auto-mint token

CORS and rate limit settings: CORS, System settings.

Sections ​

  1. Authorization
  2. Endpoint map
  3. Catalog
  4. Cart
  5. Checkout
  6. Customer
  7. Errors
  8. CORS and rate limit
  9. Examples

Custom routes and FastRoute details: API Router.