Download the PHP package vin-sw/shopware-sdk without Composer
On this page you can find all versions of the php package vin-sw/shopware-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package shopware-sdk
Shopware 6 PHP SDK
[
]()
Shopware PHP SDK is a simple SDK implementation of Shopware 6 APIs. It helps to access the API in an object-oriented way.
If you're familiar with Shopware 6 DAL syntax and how to retrieve it you might see this example is predictable and straightforward
Or sending notification from external server
| SDK version | SW schema |
|---|---|
| 2.x | 6.5 |
| 1.x | 6.4 |
You can use 1.x to connect to a sw 6.5 but for up-to-date schema and new 6.5 features, you should use 2.x version instead.
Installation
Install with Composer
The SDK main features:
-
Admin API
- CRUD API
- Sync Api
- User Config API
- Notification API
- Admin Search API
- Other services
- ... (TODO)
-
Webhook helper
- Webhook registration
- Webhook authentication
- Webhook receiver
- If you're using Laravel 8, consider check this out Laravel Shopware SDK Adapter
Usage
More in the examples folder, for integrating the sdk in an App, have a look at this repository
Admin Authentication
- Supported 3 grant types, you can create one of these 3 grant type for authentication:
Using Password grant type
Using Client credential grant type
Using Refresh token grant type
Or dynamically via
Check the authentication example for the reference.
After having a GrantType object, you can fetch the admin's access token using the AdminAuthenticator
Notice: You might want to store the access token object into the database so you can create the object without request for another access token for every Admin API request.
Working with Criteria and Repositories
It's pretty identical to what you expected when working with Shopware's core or repositories in the SW administration.
This is an example to retrieve a product that have free shipping
Each shopware's entity is mapped into Entity and Collection Classes which can be found in Data/Entity so you can easily access their properties when retrieving data from Admin API.
Support methods get, search, searchIds, create, update, delete, syncDeleted, createVersion, mergeVersion, deleteVersion, clone, schema.
Each method requires a Context object
Check examples/entity-repository.php for some useful references.
Working with App
AppRegistration examples:
The example took from a Laravel route action, but it can be the same in other frameworks
Action Button Response examples:
When receive a POST request from an action button, you can return one of these ActionResponse (PSR-7 Response) classes ported from Shopware's core
Working with Admin API Services
- Current supported services:
- InfoService
- MediaService
- UserService
- StateMachineService
- SyncService
- NotificationService
- UserConfigService
- AdminSearchService
- For other services that does not have a concrete class, use: AdminActionService
An ApiService requires a Context object as its first argument. Check examples/info-service.php for some references.
Change log
Please see CHANGELOG for more information on what has changed recently.
Working with Webhook
- Check the integration on our AppExample
Contribution
Feels free to create an issue on Github issues page or contact me directly at [email protected]
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Requirements
- ext-curl
- PHP >=7.4
- SW >= 6.4
This SDK is mainly dedicated to Shopware 6.4 and onwards, earlier SW application may still be usable without test
Credits
- vienthuong
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of shopware-sdk with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^7.0
psr/http-client Version ^1.0
guzzlehttp/psr7 Version ^2.7