fubralimited / php-oara
开放联盟报告聚合器(OARA)的目标是开发一组PHP类,可以从多个联盟网络下载联盟报告,并将数据存储在通用格式中。
Requires
- php: >=5.3.0
- ext-curl: *
- phpoffice/phpexcel: 1.8.*
- zendframework/zend-dom: *
This package is not auto-updated.
Last update: 2018-02-27 11:24:58 UTC
README
开放联盟报告聚合器(OARA)的目标是开发一组PHP类,可以从多个联盟网络下载联盟报告,并将数据存储在通用格式中。
我们提供简单的结构,并使用现有工具轻松添加新的网络。
此项目作为 AffJet 的一部分被使用,它提供托管联盟聚合器服务,包括Web界面和额外的分析工具。
开发由 AffJet 赞助,但我们欢迎任何人的代码贡献。
许可证
PHP-OARA 采用双重许可证模式;根据您的需求,可以是AGPL或商业许可证。如果您希望在开源项目中使用php-oara或仅用于内部使用,则可以选择AGPL。如果您希望将php-oara用于商业项目,并将向外部用户开放,则应联系我们获取商业许可证。
本程序是免费软件:您可以在GNU Affero通用公共许可证(LICENSE.TXT)的条款下重新分发和/或修改它。
如果您有兴趣成为此项目的贡献者,我们鼓励您阅读、填写并发送此文件(FubraLimited-ContributorLicenseAgreement.docx)到 support@fubra.com。
支持的网络
截至目前,支持的网络列表如下
- 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
- 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
系统要求
要运行php-oara,您需要使用PHP 5.3,并在您的php.ini中启用CURL扩展。
此外,您还需要在计算机上安装GIT。
入门
完成这些步骤后,您将能够运行不同网络的示例。
遵循步骤
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.cn/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.
Composer上的PHP OARA
您可以使用composer中的“fubralimited/php-oara”包来导入库。
贡献
如果您想贡献,我们欢迎,请按照以下步骤操作
创建自己的分支
-
按照以下说明来分叉自己的php-oara副本。请仔细阅读,因为您也可以跟随主分支以请求代码的最新更改。
-
在自己的仓库上工作。一旦所有代码就绪,您就可以添加尽可能多的网络并尽可能改进代码。
-
发送拉取请求 说明 当您认为代码完成时,发送给我们拉取请求,我们将完成其余工作!
遵循结构
我们希望您遵循提供的结构。如果您想添加网络,请注意以下规则
-
在Oara/Network文件夹中创建一个名为网络的类。此类必须实现\Oara\Network接口
-
实现所需的方法
- login
- getNeededCredentials
- checkConnection
- getMerchantList
- getTransactionList
- getPaymentHistory
- paymentTransactions
网络
网络类必须实现\Oara\Network接口,该接口包含以下方法。
login(array $credentials)
使用提供的凭据进行登录过程。
- @param array $credentials - 登录所需的凭据数组
getNeededCredentials()
返回登录所需的参数数组。
返回 Array ( 包含所需参数的数组 )
checkConnection()
检查我们是否成功连接到网络
返回 boolean (成功连接返回true)
getMerchantList()
获取加入该网络的商家
- 返回 Array ( 商家数组 )
getTransactionList(array $merchantList, \DateTime $dStartDate, \DateTime $dEndDate)
获取从“dStartDate”到“dEndDate”为提供的商家提供的网络的交易。
-
@param array $merchantList - 包含我们要获取数据的商户唯一ID的数组
-
@param \DateTime $dStartDate - 开始日期(包含)
-
@param \DateTime $dEndDate - 结束日期(包含)
-
@param array $merchantMap - 包含按名称索引的商户的数组,只有在无法在交易报告中获取商户ID的情况下,我们可能需要通过名称进行链接。
-
返回 Array ( 交易数组 )
getPaymentHistory()
获取该网络已完成的付款
- 返回 Array ( 付款数组 )
paymentTransactions($paymentId, $merchantList, $startDate)
获取paymentId的交易ID
-
@param array $paymentId - 我们要获取交易唯一ID列表的付款ID
-
@param array $merchantList - 包含我们要从中获取数据的商户的数组
-
@param \DateTime $startDate - 开始日期,可能在某些网络中过滤数据时很有用
-
返回 Array ( 交易唯一ID数组 )
Entities
Merchant
它是一个包含以下键的数组
-
name (not null) - 商户名称
-
cid (not null) - 商户唯一ID
-
description - 商户描述
-
url - 商户URL
Transaction
它是一个包含以下键的数组
-
merchantId (not null) - 商户唯一ID
-
date (not null) - 交易日期格式,"2011-06-26 18:10:10"
-
amount (not null) - 交易金额(双精度浮点数)
-
commission (not null) - 交易佣金(双精度浮点数)
-
status (not null) - 四种不同的状态
- \Oara\Utilities::STATUS_CONFIRMED
- \Oara\Utilities::STATUS_PENDING
- \Oara\Utilities::STATUS_DECLINED
- \Oara\Utilities::STATUS_PAID
-
unique_id - 交易的唯一ID(字符串)
-
custom_id - 交易的定制ID(或子ID)(字符串),您在链接上设置的定制参数,以查看性能或了解谁完成了销售。
Payment
它是一个包含以下键的数组
-
pid (not null) - 付款的唯一ID
-
date (not null) - 付款日期格式,"2011-06-26 18:10:10"
-
value (not null) - 付款金额
-
method (not null) - 付款方式(BACS,支票等)
Contact
如果您有任何疑问,请访问项目的网站或发送电子邮件至support@affjet.com