-
Notifications
You must be signed in to change notification settings - Fork 304
adds upgrade guide and apidocs #2134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
7172297
84995c5
33d1d60
09944aa
15d132b
e1c97cb
6d4eeca
c778b15
48f3a0c
e7d903b
2388747
16456bf
dc8d761
312d6c5
8f8b1cc
4b8ca69
4ecb86b
97c7e5e
69d0849
2bef043
24f4d31
e47d06e
d3cbf85
c7024b3
7afcb0b
4c7e3ba
c58d247
4c613cc
1539467
5dba68f
7636bab
29d2f46
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,18 @@ | ||
| --- | ||
| nav: | ||
| title: Admin API | ||
| position: 20 | ||
| position: 60 | ||
|
|
||
| --- | ||
|
|
||
| # Admin API | ||
|
|
||
| The Admin API represents the administrative and integration surface of Shopware. It enables structured access to core business entities such as products, orders, customers, media, and configurations. It is intended for backend integrations, automation, data synchronization, and system-to-system communication. | ||
|
|
||
| These integrations typically involve structured data exchange, synchronization, imports, exports, and notifications. They prioritize consistency, error handling, validation, and transactional integrity. Performance is also important in terms of high data loads rather than fast response times. | ||
|
|
||
| The Admin API provides CRUD operations for every entity within Shopware and is used to build integrations with external systems. | ||
|
|
||
| For more information, refer to the [Guides section](../../guides/integrations-api/index.md). | ||
| For details on endpoints, authentication methods, schemas, and request formats, always refer to the Admin API documentation. | ||
|
|
||
| <PageRef page="https://shopware.stoplight.io/docs/admin-api/8d53c59b2e6bc-shopware-admin-api" title="Admin API – Stoplight Reference" target="_blank" /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,17 @@ | ||
| --- | ||
| nav: | ||
| title: Store API | ||
| position: 10 | ||
| position: 50 | ||
|
|
||
| --- | ||
|
|
||
| # Store API | ||
|
|
||
| Every interaction between the store and a customer can be modeled using the Store API. It serves as a normalized layer or an interface to communicate between customer-facing applications and the Shopware Core. It can be used to build custom frontends like SPAs, native apps, or simple catalog apps. It doesn't matter what you want to build as long as you are able to consume a JSON API via HTTP. | ||
| The Store API represents the customer-facing surface of Shopware. It is designed for storefront/frontend-related interactions such as product browsing, cart handling, checkout, and customer account management. It exposes only data that is relevant and safe for frontend use and supports both anonymous and authenticated customers. | ||
|
|
||
|  | ||
| The Store API acts as a normalized interface layer between customer-facing applications and the Shopware Core. It enables headless frontends (such as SPAs or native apps) to consume Shopware functionality via JSON over HTTP. Core business logic is exposed through HTTP routes, ensuring that the Storefront and API consumers rely on the same underlying services. | ||
|
|
||
| Whenever additional logic is added to Shopware, the method of the corresponding service is exposed via a dedicated HTTP route. At the same time, it can be programmatically used to provide data to a controller or other services in the stack. This way, you can ensure that there is always common logic between the API and the Storefront and almost no redundancy. It also allows us to build core functionalities into our Storefront without compromising support for our API consumers. | ||
| For details on endpoints, authentication methods, schemas, and request formats, always refer to the Store API documentation. | ||
| <PageRef page="https://shopware.stoplight.io/docs/store-api/7b972a75a8d8d-shopware-store-api" title="Store API – Stoplight Reference" target="_blank" /> | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Using plugins, you can add custom routes to the Store API \(as well as any other routes\) and also register custom services. We don't force developers to provide API coverage for their functionalities. However, if you want to support headless applications, ensure that your plugin provides its functionalities through dedicated routes. | ||
|
|
||
| <PageRef page="../../guides/plugins/plugins/framework/store-api/" /> | ||
|
|
||
| ## Store API and the traditional TWIG storefront | ||
|
|
||
| When using the server-side rendered TWIG storefront, the Store API is not used. | ||
| Instead, the storefront uses custom [storefront controllers](../../guides/plugins/plugins/storefront/add-custom-controller.md) which internally use the Store API to fetch data. | ||
|
|
||
| The storefront controllers are optimized for the usage in our TWIG storefront. And the biggest difference is the way that authentication and authorization are handled. | ||
| As the Store-API is a proper REST API, the main design is stateless, which means authentication info needs to be provided via the request headers in form of the `sw-context-token`. | ||
| The storefront relies on the session to store the authentication info, that way you do not have to handle the authentication manually with every request. | ||
|
|
||
| ## What next? | ||
|
|
||
| * To start working with the Store API, check out our [Quick Start guide](https://shopware.stoplight.io/docs/store-api/38777d33d92dc-quick-start-guide) and explore all endpoints in our reference guide. | ||
|
|
||
| * An interesting project based on the Store API is [Composable Frontends](../../../frontends/). | ||
| Shopware provides [Composable Frontends](https://frontends.shopware.com/) as a headless frontend implementation based on the Store API. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| nav: | ||
| title: Administration | ||
| position: 10 | ||
|
|
||
| --- | ||
|
|
||
| # Administration | ||
|
|
||
| These guides cover upcoming architectural changes and migration paths affecting Administration extensions. Use them to prepare plugins for major system transitions: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. depending on the version not all of them are upcoming, vue3, pinia & vite for example are already completed
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Jonas Elfering (@keulinho) How's this? => "These guides cover architectural changes and migration paths affecting Administration extensions, helping you prepare plugins for major system transitions. Depending on the version, some changes (for example, Vue 3, Pinia, and Vite) may have already been completed." |
||
|
|
||
| * [Vue 3 migration](./vue3) | ||
| * [Meteor components](./meteor-components) | ||
| * [Pinia migration](./pinia) | ||
| * [Vite migration](./vite) | ||
| * [Vue migration build removal](./vue-migration-build) | ||
| * [Native Vue implementation](./vue-native) | ||
Uh oh!
There was an error while loading. Please reload this page.