Install

Page sections:

• marketplace - API wrapper
• marketplace_example - Examples for the API wrapper

---

marketplace

CEL.ro Marketplace API wrapper in PHP

The API wrapper can be installed in 2 ways: by using the packagist package and manually. Below are listed the necessary steps for the two methods.

Requirements

1. PHP >= 5.3
2. composer

Installation

Method 1. Packagist (recommended)

Method 1.1.

1. Create a file named composer.json with the following contents

   {  
       "require": {  
           "celdotro/marketplace": "~1.1"
       },
       "prefer-stable": true
   }

2. Run the following command

   composer install

Method 1.2.

Run the following command

composer require celdotro/marketplace

Method 2. Git clone

1. Run the following command

   git clone https://github.com/celdotro/marketplace.git

2. In newly created folder, run the following command

   composer install

Configuration

In order to use the API wrapper's methods, you will need to authenticate in the PHP script using

use celmarket\Auth;
Auth::setUserDetails('USERNAME', 'PASSWORD');

marketplace_examples

Examples for the CEL.ro Marketplace API wrapper.
It is recommended to use this project alongside the WIKI. The project can be found at this address: https://github.com/celdotro/marketplace_examples
More information about the project and its file structure: https://github.com/celdotro/marketplace_examples#en

Installation

1. Clone the git repository

   git clone https://github.com/celdotro/marketplace_examples.git

2. In newly created folder, run the following command

   composer install

Use

Method 1. Manually run each file (recommended)

1. Find the following instruction in the file and replace the USERNAME and PASSWORD with your own

   Auth::setUserDetails('USERNAME', 'PASSWORD');

2. Run the file using the PHP interpreter

   php /PATH_TO_PROJECT/Orders/1.getOrdersSummary.php

3. Decide whether to use the live or demo server. If the live server is chosen, then comment out the line containing:

   celmarket\Config::setDemo();

The file index.php lists an automatically generated contents of the project's main folders and files.

php index.php

Method 2. Use a server

The file index.php lists an automatically generated contents of the project's main folders and files.
The response is not optimised for browser, because this is a collection of examples, not a web interface.

1. Find the following instruction in the file "api_include.php" and replace the USERNAME and PASSWORD with your own

   Auth::setUserDetails('USERNAME', 'PASSWORD');

2. Decide whether to use the live or demo server. If the live server is chosen, then comment out the line containing:

   celmarket\Config::setDemo();

3. Open the following link in the browser and choose the page that corresponds to the file modified in the 1st step (change the asterisks with the server's address)

   http://****/marketplace_examples/index.php
   

marketplace.wiki

In order to clone this wiki, use:

 git clone https://github.com/celdotro/marketplace.wiki

You can read the files as they are or with a Markdown interpreter. It is recommended though to not clone it and read it directly from github.

Update 1.18.0

Starting with version 1.18.0 we released a solution for devs who manage multiple affiliate accounts.
We added an optional 3rd parameter for setUserDetails method.
This parameter should be a class which extends the AuthProvider class and has the required methods.
If no parameter is specified, the default AuthProviderFile will be used which saves the tokens for each affiliate account in separate files.
For UNIX systems the tokens are saved by default in the /tmp/ directory and for Windows, in the current script root directory.
We also added the setProviderID method which requires one parameter(string|object|array). This method helps devs which need a way to identify each affiliate by an unique ID.
Example for setProviderID using the AuthProviderFile class:

AuthProviderFile::setProviderID(string|array|object);

Complete example using AuthProviderFile class:

AuthProviderFile::setProviderID('abc');
Auth::setUserDetails('test', '1234', AuthProviderFile::class);