-
Notifications
You must be signed in to change notification settings - Fork 305
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
Merged
Merged
Changes from all commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
7172297
adds upgrade guide and apidocs
lasomethingsomething 84995c5
Update index.md
lasomethingsomething 33d1d60
Update index.md
lasomethingsomething 09944aa
Merge branch 'main' into api-upgrade-changesfeb23
lasomethingsomething 15d132b
Additional info
sushmangupta e1c97cb
Update concepts/apis/index.md
lasomethingsomething 6d4eeca
Update concepts/apis/index.md
lasomethingsomething c778b15
Update storefront-concept.md
lasomethingsomething 48f3a0c
Apply suggestion from @sushmangupta
lasomethingsomething e7d903b
Update index.md
lasomethingsomething 2388747
Update index.md
lasomethingsomething 16456bf
Update index.md
lasomethingsomething dc8d761
Update index.md
lasomethingsomething 312d6c5
Update index.md
lasomethingsomething 8f8b1cc
Update upgrade-shopware.md
lasomethingsomething 4b8ca69
Merge branch 'main' into api-upgrade-changesfeb23
lasomethingsomething 4ecb86b
Fix link
sushmangupta 97c7e5e
Language tool issue fix
sushmangupta 69d0849
Fix api directory content
sushmangupta 2bef043
Addition of Core Concept
sushmangupta 24f4d31
Update index.md
lasomethingsomething e47d06e
remove content from architecture
sushmangupta d3cbf85
Add redirects
sushmangupta c7024b3
Update gitbook, add info box, fix link
sushmangupta 7afcb0b
Update index.md
lasomethingsomething 4c7e3ba
Update index.md
lasomethingsomething c58d247
Update index.md
lasomethingsomething 4c613cc
Update upgrade-shopware.md
lasomethingsomething 1539467
Update language-pack-migration.md
lasomethingsomething 5dba68f
Update upgrade-shopware.md
lasomethingsomething 7636bab
Update store-api.md
lasomethingsomething 29d2f46
Update admin-api.md
lasomethingsomething 20fb1a0
Update index.md
lasomethingsomething 01a574b
Update index.md
lasomethingsomething 392e34b
Update index.md
lasomethingsomething a29a1e5
Update index.md
lasomethingsomething 24c32c1
Update index.md
lasomethingsomething d1ccc19
Update index.md
lasomethingsomething d6fff94
Update index.md
lasomethingsomething 2a359b6
Merge branch 'main' into api-upgrade-changesfeb23
lasomethingsomething 7725596
grammar fixes
sushmangupta bebb057
markdown fixes
sushmangupta 975c2dc
Markdown fix2
sushmangupta 4fdee7e
Markdown fix3
sushmangupta 519aacb
Spell check fix
sushmangupta 6476269
chore: sort .wordlist.txt
github-actions[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.