project sdkphpapi

cdiscount/sdkphpapi

PHP SDK for the Cdiscount Marketplace API

1- Install a web server (for example wamp for windows)

1.1 - Min requirements :

• Apache 2.2
• Php 5.6

2.1- Clone the Git repository in your root project folder

The SDK is structured like that :, _(*1)

• config/ : config files
• samples/ : samples folder
• sdk/ : content of the Cdiscount SDK (do not modifiy any file of this folder)

2.2- Run the 'composer update' command in the root path of the sdk folder to download Zend Framework dependencies

3 - Insert your API's credentials

3.1 - Requirements

To use Cdiscount Marketplace API and Cdiscount Marketplace SDK you first need to follow the steps described in the Cdiscount Marketplace API website., _(*2)

The sections are the following :, _(*3)

• Request your account creation.
• Have set up your account

3.2 - Update the config files

Follow the procedure to insert your API credentials, _(*4)

• Open the config folder
• Open the config.ini file
• Set the api mode : 'preprod' or 'prod'
• Open the preprod.config.ini file or the prod.config.ini file (if you set mode to 'prod')
• Set your api username
• Set your api password

4 - Use the SDK

4.1 - Use the endpoints

The SDK contains the following endpoints :, _(*5)

• Seller
• Offer
• Discussion
• Product
• Order
• Relay

All the SDK methods are described in the MarketPlace API Website because they have the same names of the Cdiscount Marketplace API methods., _(*6)

For each method, you have a PHP file with a sample to call the corresponding API function., _(*7)

For example, to call the GetSellerInformation API method, open the GetSellerInformation.php file contained in the Seller folder and follow the same steps of the sample., _(*8)

4.2 - CDSApiClient Object

The CDSApiClient allows you to call the API., _(*9)

The CDSApiClient object contains all the endpoints. It's also create an API call to get a token for you., _(*10)

Don't create a new CDSApiClient each time you call the API !, _(*11)

You can (have to) use the same CDSApiClient for all your API' calls., _(*12)

Here an example of how use the same CDSApiClient for many API calls :, _(*13)

$client = new \Sdk\ApiClient\CDSApiClient(); $token = $client->init(); if ($token == null || !$client->isTokenValid()) { echo "Souci lors de la génération du token"; die; } $offerPoint = $client->getOfferPoint(); $offerListResponse = $offerPoint->getOfferList(null); /** Parse here $offerListResponse **/ $sellerPoint = $client->getSellerPoint(); $sellerResponse = $sellerPoint->getSellerInformation(); /** Parse here $sellerResponse **/, _(*14)

5 - Update the SDK

Download the new SDK Zip file from the CDiscount Marketplace API Website, _(*15)

Erase the SDK folder with the new one, _(*16)

Erase the vendor folder with the new one, _(*17)

Notes

In the sample, the parametrer error_reporting is set to '-1'. Do not let it in production mode., _(*18)