Development

Section for developers extending MiniShop3 functionality.

Contents

• Events — event system for plugins
• REST API — Web API for frontend integration
• API Router — routing, middleware, custom routes
• Scheduler — background tasks and Scheduler integration
• Models and DB schema — xPDO models and table structure
• Service layer — DI container, extending and replacing services
• JavaScript API — Headless API for SPA (Vue, React, Vanilla JS)
• Frontend JavaScript — full documentation including UI layer
• Product tabs integration — adding tabs to the product page
• Order tabs integration — adding tabs to the order page
• Backend API — programmatic API for working with entities from PHP (products, orders, options, customers)

Manager API and processors

As of 1.10+, most manager screens use the Manager REST API (Controllers\Api\Manager\* via FastRoute). Legacy processors (MiniShop3\Processors\*) remain for:

• legacy connector / runProcessor() from PHP;
• utilities where the controller explicitly calls a processor (RunsMs3Processors: import, bulk gallery updates);
• some settings where events are still tied to the processor lifecycle.

Vue CRUD (vendors, deliveries, payments, etc.) does not call Processors/Settings/Vendor/* — plugins on msOnVendorCreate from the admin UI will not run. See Vendor events.

The headless storefront uses Web API (/api/v1/*), not processors.