REST API
MiniShop3 Web API (api.php) handles the storefront and headless clients: cart, checkout, customer account, public catalog. Manager API (connector.php) runs under a MODX session for the Vue admin and is not covered here.
text
/assets/components/minishop3/api.php?route=/api/v1/...| File | What is inside |
|---|---|
core/components/minishop3/config/routes/web.php | Web API routes |
core/config/ms3_routes_web.custom.php | Your own routes. Not shipped — you create it |
core/config/ms3.routes.d/web/*.php | Add-on route fragments. The directory is not shipped |
Documentation
| Section | Contents |
|---|---|
| Overview | Envelope, middleware, base URL |
| Authorization | Token, cookie, Bearer, login, me, refresh |
| Endpoint map | Full path table from web.php |
| Catalog | product, category, filters, ACL |
| Cart | Mutations and cart/get format |
| Checkout | delivery/payment list, order, cost, submit |
| Customer | Profile, addresses, orders, email |
| Errors | code, errors, error_code, HTTP |
| CORS and rate limit | Origins, credentials, 429 |
| Examples | curl and TypeScript/$fetch |
- Routing and your own routes — API Router
- Storefront JS on the same domain — Frontend JavaScript