Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/padosoft/laravel-affiliate-network
Affiliate Networks API wrapper to provide common interface for affiliate networks program API
https://github.com/padosoft/laravel-affiliate-network
affiliate-networks commission-junction laravel laravel-command laravel-package tradedoubler zanox
Last synced: 3 days ago
JSON representation
Affiliate Networks API wrapper to provide common interface for affiliate networks program API
- Host: GitHub
- URL: https://github.com/padosoft/laravel-affiliate-network
- Owner: padosoft
- License: mit
- Created: 2016-11-14T19:26:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-28T16:58:05.000Z (over 1 year ago)
- Last Synced: 2024-12-26T02:12:00.516Z (10 days ago)
- Topics: affiliate-networks, commission-junction, laravel, laravel-command, laravel-package, tradedoubler, zanox
- Language: PHP
- Size: 403 KB
- Stars: 74
- Watchers: 13
- Forks: 24
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Affiliate Networks API wrapper to provide common interface for affiliate networks publish API like Zanoz, Tradedoubler, Commission Junction etc...
[](https://packagist.org/packages/padosoft/laravel-affiliate-network)
[](LICENSE.md)
[](https://travis-ci.org/padosoft/laravel-affiliate-network)
[](https://scrutinizer-ci.com/g/padosoft/laravel-affiliate-network)
[](https://packagist.org/packages/padosoft/laravel-affiliate-network)
[](https://insight.sensiolabs.com/projects/0008f1c1-34b2-4abd-8810-5bf5819ce45e)
The goal of this Laravel package is to wrap the Publisher Network Affiliate API like Zanox, Tradedoubler, Commission Junction etc.. and provide simple methods to get deals and sales report and return a common interface for your use.
##Overview
Common methods are:
- getDeals : get the network deals.
- getSales : get the network sales.
- getStats : get the network deals stats.
- getMerchants : get the network merchants.
- checkLogin : check if logged in network.
- login : login in into network.
- getTrackingParameter : get network tracking params.
- loadAvailableNetworks : get all available network.
- hasNetwork : check if network are available.
- addNetwork : add a network class that implements Network interface.
##Requires
- php: >=7.0.0
- illuminate/support
- padosoft/support
## Installation
You can install the package via composer:
```bash
$ composer require padosoft/laravel-affiliate-network
```
You must install this service provider.
``` php
// config/app.php
'provider' => [
...
Padosoft\AffiliateNetwork\AffiliateNetworkServiceProvider::class,
...
];
```
You don't need to register the command in app/Console/Kernel.php, because it provides by AffiliateNetworkServiceProvider register() method.
You can publish the config file of this package with this command:
``` bash
php artisan vendor:publish --provider="Padosoft\AffiliateNetwork\AffiliateNetworkServiceProvider"
```
The following config file will be published in `config/laravel-affiliate-network.php`
``` php
return array(
'zanox' => array(
'username' => env(
'ZANOX_USERNAME',
'padosoft'
),
'password' => env(
'ZANOX_PASSWORD',
''
)
),
'tradedoubler' => array(
'username' => env(
'TRADEDOUBLER_USERNAME',
'padosoft'
),
'password' => env(
'TRADEDOUBLER_PASSWORD',
''
)
),
'commissionjunction' => array(
'username' => env(
'COMMISSIONJUNCTION_USERNAME',
'padosoft'
),
'password' => env(
'COMMISSIONJUNCTION_PASSWORD',
''
)
),
);
```
In your app config folder you can copy from src/config/.env.example the settings for yours .env file used in laravel-affiliate-network.php.
If you use mathiasgrimm/laravel-env-validator
in src/config folder you'll find an example for validate the env settings.
## Networks Supported
- CommissionJunction
- Effiliation
- Netaffiliation
- Publicideas.com
- TradeDoubler
- Zanox
- WebGains
## Usage
Create new php file, add composer autoload and start using functions.
```php
login('Zanox',$_ENV['ZANOX_USERNAME'], $_ENV['ZANOX_PASSWORD']);
$isLogged = $objNetworkManager->checkLogin('Zanox');
if ($isLogged){
echo '
Deals
';
$arrDeals = $objNetworkManager->getDeals('Zanox');
echo '';
var_dump($arrDeals);
echo '
';
}
```
In Laravel:
```php
$networkManager=app(NetworkManager::class);
$dateFrom=new DateTime();
$dateTo= new DateTime();
//if you want to specify specific Merchant:
$arrMerchantID = array(
array('cid' => '9716', 'name' => 'Zalando IT')
);
$networkManager->login('Zanox',$_ENV['ZANOX_USERNAME'], $_ENV['ZANOX_PASSWORD']);
$isLogged = $networkManager->checkLogin('Zanox');
if ($isLogged){
echo '
Transactions
';
$transactions = $networkManager->getSales('Zanox',$dateFrom,$dateTo,$arrMerchantID);
echo 'Deals
';
$arrDeals = $networkManager->getDeals('Zanox');
echo '';
var_dump($arrDeals);
echo '
';
}
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email instead of using the issue tracker.
## Credits
- [Lorenzo Padovani](https://github.com/lopadova)
- [All Contributors](../../contributors)
## About Padosoft
Padosoft (https://www.padosoft.com) is a software house based in Florence, Italy. Specialized in E-commerce and web sites.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.