A PHP wrapper for the Magento 2 APIs offering ease of use for retrieving and setting data.
PLEASE NOTE: for now this project is alpha stability, breaking changes might be made in the near future. For now the main focus is on retrieving info
Install module via composer.
Use the vendor/bin/magesdk token:admin tool to create the required API tokens
- Store config: API + Model, should maybe add an object class instead of array
- Directory country & currency: API + Objects
- Product: work in progress on Model, API, Object
- Integration Token: created API classes, no other objects required, are used by CLI tool
Sounds a lot more fancy than it is but the basic idea is you have API classes, Object classes and Models.
API files located in src/V1 follow the same directory structure as the API url itself.
- Models are what you want to use in your projects. The idea is to keep them stable between versions.
- Object classes offer an easy way to explore what data is (or should be) in a certain entity.
- API classes do the actual communication with the API via the Api\Client library
There are 4 basic goals to this SDK library
- Make using the Magento 2 API easy
- Offer any 'missing' business logic you might need when using the APIs
- Keep the library as simple as possible
- Isolate your project from any breaking changes
Use the tagged versions in the repo. They should reflect the compatible Magento 2 version plus some internal versioning
All integration tests were written on a Magento 2 instance with unmodified sample data. The ClientTest uses httpbin.org to test itself, for the other tests using Magento 2 I recommend using a local M2 install
I would love to have some help on this project. With PRs, bug reporting or just give your opinion on how this could be improved via a feature issue.