heyday/silverstripe-vend

Provides Vend API integration for SilverStripe

Silverstripe Vend API integration

This module is just a wrapper around the VendAPI package by @brucealdridge for Silverstripe., _(*1)

This brings implementation for OAuth2 with token management., _(*2)

Requires

• Silverstripe 4+
• The vendapi/vendapi package

Install

composer require heyday/silverstripe-vend, _(*3)

Setup

First you need to sign up for a Vend developer account and create an app: https://developers.vendhq.com/, _(*4)

When you have done so, set your details in a yml config file under VendAPI., _(*5)

eg:, _(*6)

mysite/_config/vend.yml:, _(*7)

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., _(*8)

eg if I have setup http://mysite.com/admin/vend/authorise as my RedirectURI on my Vend app:, _(*9)

mysite/_config/routing.yml :, _(*10)

---
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., _(*11)

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., _(*12)

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., _(*13)

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., _(*14)

eg:, _(*15)

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();
    }