gunharth/laravel-lightspeed-api

A Laravel wrapper for the Lightspeed Seoshop API

Laravel 5 Lightspeed Seoshop API Wrapper

, _(*1)

This package makes working with the Lightspeed eCom API a breeze. Once installed you can perform all API calls like so:, _(*2)

use ShopApi;

// shop info
$shopInfo = ShopApi::shop()->get();

// retrieve all products
$products = ShopApi::products()->get(); // Note: by default the API spits out 50 items with a max of 250

// with params
$products = ShopApi::products()->get(null, array('page' => 1, 'limit' => 100));

// product info with id
$productInfo = ShopApi::products()->get(1);

// to change the API language
ShopApi::setApiLanguage('de');

Consult the Lightspeed eCom API docs for all of the API options., _(*3)

Installation

Install the package via composer:, _(*4)

composer require gunharth/laravel-lightspeed-api

Next up the service provider must be registered:, _(*5)

'providers' => [
    ...
    Gunharth\Lightspeed\LightspeedServiceProvider::class,
];

Register the Gunharth\Lightspeed\LightspeedFacade Facade:, _(*6)

'aliases' => [
    ...
    'ShopApi' => Gunharth\Lightspeed\LightspeedFacade::class,
    ...
]

Publish the configuration with this command:, _(*7)

php artisan vendor:publish --provider="Gunharth\Lightspeed\LightspeedServiceProvider"

This will publish file called lightspeed-api.php in your config-directory with this contents:, _(*8)

<?php

return [

    /*
     * Lightspeed cluser_id
     */
    'cluster_id' => '',

     /*
     * Lightspeed API key
     */
    'api_key' => '',

    /*
     * Lightspeed API secret
     */
    'api_secret' => '',

    /*
     * Lightspeed Default API Language
     */
    'locale' => '',

];

Read the Lightspeed eCom API docs to learn on how to set the correct values and api keys., _(*9)

Contributing

Please see CONTRIBUTING for details., _(*10)

License

The MIT License (MIT). Please see License File for more information., _(*11)