lemonway/php-sdk

PHP SDK for Lemon Way API

⚠️WARNING: This client is deprecated⚠️, _(*1)

This repository is in Maintenance Mode

We recommend our new partners to use DirectkitJson2 following this example, _(*2)

We will keep supporting this repository only for old customers who couldn't migrate to DirectkitJson2 (recommended) or SoapClient:, _(*3)

• we will make only minimum changes to fix small bugs.
• Big pull-request (which make a lot of changes in the code) will be rejected.

The LemonWay API (called Directkit) has two implementations: DirectkitJson2 and DirectkitXml. There are different ways to call the service depends on the implementation you chose., _(*4)

The json format is usually more network-efficient, and simpler to integrate. It is the reason why the DirectkitJson2 is recommended., _(*5)

Anyway, if you don't like the json format, you can also send SOAP (XML) requests to the DirectkitXml. There are 3 different ways to call the DirectkitXml:, _(*6)

1. SoapClient: the casual method in PHP to consume any Web Service. It is the simplest way to access to DirectkitXml.
2. SoapClient SDK: same with the first method, but all the structure of requests / responses are generated overhead with wsdl2phpgenerator
3. LemonWay SDK: call the web service as a normal http request [curl_init]. The SDK will help you to parse the SOAP response.

We recommend the first method with SoapClient because it is the standard solution in PHP world., _(*7)

This example demonstrates the third method. The LemonWay SDK doesn't really have any advantages over other methods (see an opinionated comparisons here). But we will keep maintaining the LemonWay SDK for old customers., _(*8)

Lemon Way PHP SDK (This SDK is only used with Direckit XML)

Lemon Way SDK is a PHP client library to work with Lemon Way API., _(*9)

Installation with Composer

You can use Lemon Way SDK library as a dependency in your project with Composer (which is the preferred technique). Follow these installation instructions if you do not already have Composer installed. A composer.json file is available in the repository and it has been referenced from Packagist., _(*10)

The installation with Composer is easy and reliable:, _(*11)

Step 1 - Add the Lemon Way SDK as a dependency by executing the following command:, _(*12)

you@yourhost:/path/to/your-project$ composer require lemonway/php-sdk:^1.0

Step 2 - Update your dependencies with Composer, _(*13)

you@yourhost:/path/to/your-project$ composer update

Step 3 - Finally, be sure to include the autoloader in your project, _(*14)

require_once '/path/to/your-project/vendor/autoload.php';

The Library has been added into your dependencies and is ready to be used., _(*15)

Installation without Composer

SDK has been written in PHP 5.4. You should ensure that curl and openssl extensions (that are part of standard PHP distribution) are enabled in your PHP installation., _(*16)

The project attempts to comply with PSR-4 specification for autoloading classes from file paths. As a namespace prefix is LemonWay\ with base directory /path/to/your-project/., _(*17)

But if you're not using PSR-4 or Composer, the installation is as easy as downloading the library and storing it under any location that will be available for including in your project (don't forget to include the required library dependencies though):, _(*18)

    require_once '/path/to/your-project/LemonWay/Autoloader.php';

Contacts

Report bugs or suggest features using issue tracker on GitHub., _(*19)

Account creation

You need a sandbox to run Examples., _(*20)

Configuration

Using the credentials information from Lemon Way support, you should then set $api->config->wlLogin to your Lemon Way login and $api->config->wlPass to your Lemon Way password., _(*21)

require_once '/path/to/your-project/vendor/autoload.php';
$api = new LemonWayAPI();

$api->config->dkUrl = 'Your DirectKitXML url';
$api->config->wkUrl = 'Your WebKit url';
$api->config->wlLogin = 'Your login';
$api->config->wlPass = 'Your password';
$api->config->lang = 'Your language';
//$api->config->isDebugEnabled = true; //Uncomment to turn on debug mode

// call some API methods...
$result = $api->RegisterWallet(...);

Response Object

All LemonWayAPI methods are returning \LemonWay\ApiResponse object. It is a dynamic object with variable properties., _(*22)

Fixed properties :

Variable properties:

Those properties depends of which method was called., _(*23)

Sample usage

require_once '/path/to/your-project/vendor/autoload.php';
$api = new LemonWayAPI();

$api->config->dkUrl = 'Your DirectKitXML url';
$api->config->wkUrl = 'Your WebKit url';
$api->config->wlLogin = 'Your login';
$api->config->wlPass = 'Your password';
$api->config->lang = 'Your language';


// call some API methods...
$walletID = 'Fill in with a unique id';
$response = $api->RegisterWallet(array('wallet' => $walletID,
                                        'clientMail' => $walletID.'@mail.fr',
                                        'clientTitle' => Wallet::UNKNOWN,
                                        'clientFirstName' => 'Paul',
                                        'clientLastName' => 'Atreides'));
if (isset($response->lwError)) {
    print 'Error, code '.$response->lwError->CODE.' : '.$response->lwError->MSG;
} else {
    print '<br/>Wallet created : ' . $response->wallet->ID;

    // OR BY USING lwXml :
    print '<br/>Wallet created : ' . $response->lwXml->WALLET->ID;
}

Get started with our examples

In the examples folder, you can find an example for each API method., _(*24)

You need to run the examples in a web server with php configured and a hostname different from localhost., _(*25)

You also need a sandbox if you want to run examples (contact Lemon Way to create a sandbox), _(*26)

An API method / example match table could be find in the Index of examples folder in HTML format and also in MarkDown in the examples folder README.md., _(*27)

Configuration

By default, the examples run with our sandbox demo. If you need your own sandbox, please contact Lemon Way then do these configurations. There's two files that handles the examples configuration:, _(*28)