Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Lightspeed eCom](http://developers.seoshop.com/assets/gfx/logo.png)
![Lightspeed eCom](https://developers.lightspeedhq.com/images/new_logo.png)

[![Latest Stable Version](http://img.shields.io/packagist/v/seoshop/seoshop-php.svg)](https://packagist.org/packages/seoshop/seoshop-php)
[![Latest Unstable Version](http://img.shields.io/packagist/vpre/seoshop/seoshop-php.svg)](https://packagist.org/packages/seoshop/seoshop-php)
Expand All @@ -7,39 +7,39 @@
# Lightspeed eCom PHP API client
This package is a convenience wrapper to communicate with the Lightspeed eCom REST-API.


## Requirements
To use the Lightspeed eCom PHP API client, the following things are required:

+ PHP >= 5.4
+ cURL, JSON, mbstring and FileInfo PHP extensions


## Installation
For the installation of the client, there are 2 ways. The composer way is preferable, but not always possible.

### Composer
**Note: From client version 1.9.0 and upward, we will only support PHP 5.4 and above.**
By far the easiest way to install the Lightspeed eCom PHP API client is to require it with [Composer](http://getcomposer.org/doc/00-intro.md).

Include the package in your `composer.json` file
``` json
``` bash
$ composer require seoshop/seoshop-php:^1.9
```
```json
{
"require": {
"seoshop/seoshop-php": "^1.9"
}
}
```

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

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

// ...
```

### Manual
### Manual Installation
Obtain the latest version of the Lightspeed eCom PHP API client
``` bash
git clone https://github.com/SEOshop/API-PHP-Client
```

And include the class in your project
``` php
require_once '/path/to/WebshopappApiClient.php';
require_once '/path/to/lightspeed-php-sdk/src/ApiClient.php';
```

## Usage
Expand All @@ -49,7 +49,7 @@ There are a lot of API resources that are accessible through this client. You ca
<?php
require 'vendor/autoload.php';

$client = new WebshopappApiClient('[api-server]', '[api-key]', '[api-secret]', '[language]');
$client = new \Lightspeed\ApiClient('[api-server]', '[api-key]', '[api-secret]', '[language]');

$shopInfo = $client->shop->get();
```
Expand Down
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
"ext-fileinfo": "*"
},
"autoload": {
"files": ["src/WebshopappApiClient.php"]
"psr-4": {
"Lightspeed\\": "src/"
}
}
}
Loading