README

The goal of the Open Affiliate Report Aggregator (OARA) is to develop a set of PHP classes that can download affiliate reports from a number of affiliate networks, and store the data in a common format.

We provide a simple structure and make it easy to add new networks using the tools available.

This project is being used as part of AffJet, which offers a hosted Affiliate Aggregator service, with a web interface and additional analysis tools.

Development is sponsored by AffJet but we welcome code contributions from anyone.

License

PHP-OARA is available under a dual license model; either AGPL or a commercial license, depending on your requirements. If you wish to use php-oara in an open source project, or one for internal use only then you can choose the AGPL. If you wish to use php-oara in a commercial project that will be available to external users, then you should contact us for a commercial license.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License (LICENSE.TXT).

If you are interested in being a contributor to this project we encourage to read, fill and send this file (FubraLimited-ContributorLicenseAgreement.docx) to support@fubra.com.

Networks Supported

The list of supported networks for Publishers so far is:

AffiliNet
Affiliate4You
AffiliateFuture
AffiliateGateway
AffiliateGroove
AffiliateWindow
AffiliatesUnited
Afiliant
Afilio
Amazon
AutoEurope
AvantLink
BTGuard
Belboon
Bet365
Bol
CgtAffiliate
Chegg
ClickBank
ClixGalore
CommissionFactory
CommissionJunction
Daisycon
Demo
Dgm
Dianomi
DirectTrack
Ebay
Effiliation
Etrader
FashionTraffic
FoxTransfer
GetCake
Globelink
GoogleAndroidPublisher
Groupon
HasOffers
HavasMedia
HideMyAss
Invia
Itunes
Ladbrokers
LinkShare
Mall
MyPcBackUP
NetAffiliation
Omnicom
PaddyPower
PaidOnResults
ParkAndGo
PayMode
PepperJam
PepperJam with api
PerformanceHorizon
PostAffiliatePro
PrivateInternetAccess
Publicidees
PureVPN
RentalCars
SalesMedia
ShareASale
Shuttlefare
SilverTap
Simpl
Skimlinks
SkyParkSecure
SkyScanner
Smg
SportCoverDirect
Steak
Stream20
TerraVision
TradeDoubler
TradeTracker
Tyroo
Viagogo
VigLink
VpnAffiliates
WebGains
WebHostingHub
WebePartners
Wehkamp
WinnerAffiliates
WowTrk
Zanox
AffiliateGateway\AU
AffiliateGateway\UK
AvantLink\CA
LinkShare\AU
LinkShare\BR
LinkShare\CA
LinkShare\DE
LinkShare\EU
LinkShare\FR
LinkShare\LA
LinkShare\UK
LinkShare\US

System Requirements

To run php-oara you will need to use PHP 5.3, and enable the CURL extension in your php.ini.

Also you will need to have GIT installed in your computer.

Getting Started

Once you have finished these steps you will be able to run the examples for the different networks.

Follow the steps

1. Create the folder with the clone of the code.

git clone https://github.com/fubralimited/php-oara.git php-oara

2. Change the directory to the root of the project

cd php-oara

3. Initialise composer

curl -s https://getcomposer.org/installer | php --
php composer.phar self-update
php composer.phar install

5. test.php

In the examples folder a "test.php" has been provided.
Instantiate a network (new \Oara\Network\Publisher\LinkShare\UK() for example), and set
the needed credentials to login.

PHP OARA on Composer

You can use the package "fubralimited/php-oara" from composer instead to import the library.

Contributing

If you want to contribute, you are welcome, please follow the next steps:

Create your own fork

Follow the next instructions to fork your own copy of php-oara. Please read it carefully, as you can also follow the main branch in order to request the last changes in the code.
Work on your own repository. Once all the code is in place you are free to add as many networks and improve the code as much as you can.
Send a pull request instructions When you think that your code is finished, send us a pull request and we will do the rest!

Follow the structure

We would like you to follow the structure provided. If you want to add a network, please pay attention to the next rules:

Create a class in the Oara/Network folder with the name of the network. This class must implement the \Oara\Network Interface
Implement the methods needed:
- login
- getNeededCredentials
- checkConnection
- getMerchantList
- getTransactionList
- getPaymentHistory
- paymentTransactions

Network

The network classes must implement the \Oara\Network interface, which includes these methods.

login(array $credentials)

Makes the login process with the credentials provided.

@param array $credentials - array with credentials to login

getNeededCredentials()

Returns an array with the required parameters to login.

return Array ( Array with required parameters)

checkConnection()

It checks if we are succesfully connected to the network

return boolean (true is connected successfully)

getMerchantList()

Gets the merchants joined for the network

return Array ( Array of Merchants )

getTransactionList(array $merchantList, \DateTime $dStartDate, \DateTime $dEndDate)

Gets the transactions for the network, from the "dStartDate" until "dEndDate" for the merchants provided

@param array $merchantList - array with the merchants unique id we want to retrieve the data from
@param \DateTime $dStartDate - start date (included)
@param \DateTime $dEndDate - end date (included)
@param array $merchantMap - array with the merchants indexed by name, only in case we can't get the merchant id in the transaction report, we may need to link it by name.
return Array ( Array of Transactions )

getPaymentHistory()

Gets the Payments already done for this network

return Array ( Array of Payments )

paymentTransactions($paymentId, $merchantList, $startDate)

Gets the Transactions Id for a paymentId

@param array $paymentId - Payment Id of the payment we want the trasactions unique_id list.
@param array $merchantList - array with the merchants we want to retrieve the data from
@param \DateTime $startDate - start date ,it may be useful to filter the data in some networks
return Array ( Array of Transcation unique_id )

Entities

Merchant

It's an array with the following keys:

name (not null) - Merchant's name
cid (not null) - Merchant's unique id
description - Merchant's description
url - Merchant's url

Transaction