seoshop/seoshop-php

PHP client for the Lightspeed eCom API

, _(*1)

, _(*2)

Lightspeed eCom PHP API client

This package is a convenience wrapper to communicate with the Lightspeed eCom REST-API., _(*3)

Installation

For the installation of the client, there are 2 ways. The composer way is preferable, but not always possible., _(*4)

Composer

Note: From client version 1.9.0 and upward, we will only support PHP 5.4 and above., _(*5)

Include the package in your composer.json file ``` json { "require": { "seoshop/seoshop-php": "^1.9" } }, _(*6)

...then run `composer update` and load the composer autoloader:

``` php
<?php
require 'vendor/autoload.php';

// ...

Manual

Obtain the latest version of the Lightspeed eCom PHP API client ``` bash git clone https://github.com/SEOshop/API-PHP-Client, _(*7)

And include the class in your project
``` php
require_once '/path/to/WebshopappApiClient.php';

Usage

There are a lot of API resources that are accessible through this client. You can look them up by looking at the code. Their name matches the name in the documentation., _(*8)

``` php <?php require 'vendor/autoload.php';, <sub>(*9)</sub>

$client = new WebshopappApiClient('[api-server]', '[api-key]', '[api-secret]', '[language]');, <sub>(*10)</sub>

$shopInfo = $client->shop->get();, <sub>(*11)</sub>

__Explanation__

[api-server]
Available server(-clusters): live, eu1, us1

[api-key]
The API key you've received or created

[api-secret]
The API secret you've received or created

[language]
Language shortcode that's available in the shop you're connecting to

## Fetching response headers
After making a call, you can fetch the response headers from our API server and use it to check important data such as rate limiting.

``` php
$shopInfo = $client->shop->get();
$response = $shopInfo->getResponseHeaders();

Getting started

Lightspeed eCom offers a powerful set of API’s for developers to create awesome apps. The API provides developers the interface to connect with third party software such as accounting-, feedback-, e-mailmarketing- and inventory management-software, or extend with new features that interact with our core platform, such as loyalty programs, social-sharing programs or reporting tools., <sub>(*12)</sub>

Getting started with Lightspeed eCom is easy. Not a partner yet? Please sign up as a partner and claim your account details and API keys., <sub>(*13)</sub>

Read our tutorials on how to build and publish your first app. Check our introduction to find out how to use the API, <sub>(*14)</sub>

Documentation

More documentation can be found at developers.lightspeedhq.com/ecom, <sub>(*15)</sub>

Contributing

We love contributions, but please note that the API client is generated. If you have suggested changes, you may still create a PR, but your PR will not be merged. We will however adapt the generator to reflect your changes. You can also create a GitHub issue if there's something you miss., <sub>(*16)</sub>

Unofficial clients for other languages

• PHP
  • laravel-lightspeed-api by Gunharth Randolf @gunharth
• Ruby
  • seoshop-api by Yotpo Ltd @YotpoLtd
• Java
  • lightspeedecom-api by Falkplan