Workarea provides two separate REST APIs for different purposes:
- The Admin API provides CRUD operations on all data models in the application and is primarily used for integration with external service providers, such as an OMS or ERP. Access is only available to admin users with the necessary "API Access" permissions.
- The Storefront API is suitable for building alternative user interfaces to Workarea. Some possible uses for the Storefront API are: mobile apps, kiosks, or retail integrations.
Both of these APIs are contained in the workarea-api plugin.
Out of the box documentation for the Workarea APIs are available here:
When running the Workarea API in your application you should reference the documentation generated for your application specifically. Generated API docs include customizations to data models, as well as any endpoints available for installed plugins.Generated docs are available at https://your.staging.url.com/api/docs
For instructions on generating app specific API documentation, see the Documentation section of the Workarea API Readme
How'd We Do?
Was this article missing something?
Was it not quite what you were looking for?
Do you have suggestions on how we could improve this article or your experience in general?
If so, please take a moment to let us know!
Your invaluable feedback will help everyone better understand the platform!