OpenAPI
MyShopie generates OpenAPI from backend annotations (l5-swagger). Engineers can use the interactive UI on the API host; merchants and integrators should start from these docs.
Where to look
Section titled “Where to look”| Audience | Entry |
|---|---|
| This docs site | Guides under /api/ |
| Platform engineers | Tenant /api/documentation on the app deployment (internal) |
Using the spec
Section titled “Using the spec”- Authenticate with a staff token or scoped
msh_key (Authentication). - Call tenant routes under
/api/v1/…. - Prefer documented scopes for write operations.
Machine-readable export can be published here as the OpenAPI JSON stabilizes for public use. Until then, treat the Admin and Storefront guides as the contract summary.