Download the PHP package simplesquid/vend-sdk without Composer

On this page you can find all versions of the php package simplesquid/vend-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of simplesquid/vend-sdk

Informations about the package vend-sdk

Vend SDK (a PHP client)

Latest Version on Packagist Build Status Total Downloads

An unofficial PHP SDK for the Vend POS API.

Installation

You can install this package via composer:

Setup

To setup, get the instance of the SDK and set the desired user agent and settings:

It is advisable that you use the client object as a singleton, however, there is no explicit restriction for this.

Usage

This outlines a typical sequence of instructions, but is not a complete list of all the functionality of the SDK. Please review the code for more advanced usages. It is also suggested you read the Vend API documentation.

Alternatively, you can see a working authorisation implementation in our Laravel Vend SDK package.

Authorisation

You have two options for authorisation with the Vend API, a Personal Access Token or OAuth 2.0.

Personal Access Token

When using the Personal Access Token, simply setup the Vend client like so:

OAuth 2.0

Setup the Vend client with the OAuth identifiers:

Initial authorisation procedure

Send the user to the OAuth URL generated by:

Use the domain prefix and authorisation code returned from the OAuth process:

Make sure you store the returned Token object and the domain prefix.

Subsequent setup procedure

Once you have received the initial authorisation, you may setup the Vend client using the Token object received during the authorisation process:

If a request throws a \SimpleSquid\Vend\Exceptions\TokenExpiredException, you can refresh the token like so:

Again, make sure you store the returned Token object.

Requests

To see all the available requests, take a look at traits located in the Actions folder. As an example, Products can be managed using the following requests:

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

Package skeleton based on spatie/skeleton-php.

About us

SimpleSquid is a small web development and design company based in Cape Town, South Africa.

License

The MIT License (MIT). Please see License File for more information.

All versions of vend-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3
ext-json Version *
guzzlehttp/guzzle Version ^6.3
spatie/data-transfer-object Version ~1.11.0
nesbot/carbon Version ^2.23
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package simplesquid/vend-sdk contains the following files

Loading the files please wait ....