gunharth / laravel-lightspeed-api
A Laravel wrapper for the Lightspeed Seoshop API
Installs: 16 958
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 3
Open Issues: 0
Requires
- php: ^7.0
- illuminate/support: ^5.2.8
- seoshop/seoshop-php: ^1.8
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: ^5.3.4
This package is not auto-updated.
Last update: 2024-12-21 21:36:45 UTC
README
This package makes working with the Lightspeed eCom API a breeze. Once installed you can perform all API calls like so:
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.
Installation
Install the package via composer:
composer require gunharth/laravel-lightspeed-api
Next up the service provider must be registered:
'providers' => [ ... Gunharth\Lightspeed\LightspeedServiceProvider::class, ];
Register the Gunharth\Lightspeed\LightspeedFacade
Facade:
'aliases' => [ ... 'ShopApi' => Gunharth\Lightspeed\LightspeedFacade::class, ... ]
Publish the configuration with this command:
php artisan vendor:publish --provider="Gunharth\Lightspeed\LightspeedServiceProvider"
This will publish file called lightspeed-api.php
in your config-directory with this contents:
<?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.
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.