REST & GraphQL API (v2) v26.7+ ยท beta
Base URL:
https://your-domain.com/apiEntry Point:public/rest.php(bootstraps Maho + Symfony API Platform)
Beta status
The v2 API ships fully tested and production-hardened, but it is published as beta for its first release cycle: field names, endpoint shapes, and GraphQL types may still receive small refinements based on real-world integrator feedback before the contract is frozen. Any such change will be listed in the release notes. If you hit a rough edge, please open an issue.
Maho's v2 API is built on API Platform and exposes the storefront and admin domains over both REST and GraphQL. The pages below cover authentication, request conventions, the full endpoint catalogue, error handling, and how to extend the API from third-party modules.
Contents
- Authentication
- Conventions - request headers, pagination, HTTP caching, idempotency keys
- GraphQL
- Endpoints
- Error Responses
- CAPTCHA
- Architecture - base classes, opt-in traits, shared services
- API Documentation (Swagger UI / OpenAPI)
- Web Server Configuration
- Extending & Deployment - adding resources, third-party modules, deployment notes