heyday / silverstripe-vend
Provides Vend API integration for SilverStripe
Installs: 1 810
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 23
Forks: 3
Type:silverstripe-vendormodule
Requires
- vendapi/vendapi: 1.5
README
This module is just a wrapper around the VendAPI package by @brucealdridge for Silverstripe.
This brings implementation for OAuth2 with token management.
Requires
- Silverstripe 4+
- The vendapi/vendapi package
Install
composer require heyday/silverstripe-vend
##Setup
First you need to sign up for a Vend developer account and create an app: https://developers.vendhq.com/
When you have done so, set your details in a yml config file under VendAPI
.
eg:
mysite/_config/vend.yml
:
VendAPI\VendAPI: clientID: g6ohGHJgJHKtuyfUTYfjVjhGhfTUYfTU clientSecret: iyGFktyFKUYlguKHkjHUHUiGHKuHGKj redirectURI: admin/vend/authorise
Also map the route you have setup as a redirectURI in your Vend app to the
Heyday\Vend\SilverStripe\Authorise_Controller
. This controller handles the
data returned by the Vend API when you first authorise the app to connect to
your store.
eg if I have setup http://mysite.com/admin/vend/authorise
as my RedirectURI on
my Vend app:
mysite/_config/routing.yml
:
--- Name: vendroutes After: 'framework/routes#coreroutes' --- Director: rules: 'admin/vend/authorise': 'Heyday\Vend\SilverStripe\Authorise_Controller' ---
After a dev/build
and a flush
you should have a new Menu called Vend Admin
where the next steps of the setup are done.
You (or the owner of the shop) needd to fill in the shop name, after which a link will appear. When the link is selected you'll be presented with a request for the app to access your shop. Once it is authorised, the first token is stored in the database along with the refresh token and the cycle starts.
Every time the connection is instantiated, a check is run to see if the token
has expired. A new one is issued if required. It does the same for the
refresh_token
.
Implementation
To use you just need to inject the Heyday\Vend\Connection
where you want to
use it and follow the docs of the VendAPI
package for the other methods.
eg:
Injection config
SilverStripe\Core\Injector\Injector: Your\Namespace\SomePageController: properties: VendConnection: '%$Heyday\Vend\Connection'
Implementation in SomePageController
protected $vendConnection; public function setVendConnection($vendConnection) { $this->vendConnection = $vendConnection; } public function VendTest() { $products = $this->vendConnection->getProducts(); }