ppbox is a framework to integrate various PayPal functionalities under a single library. It provides REST based interface to integrate with merchant's cart application. It also supports direct interface for PHP applications who want to avoid REST calls.
The primary intent of this framework is to provide a common and simple interface for merchant's cart application along-with the support for configuring business functionalities and PayPal specific details separately (without affecting each other). We have designed this framework from ground-up for making it easy to add new functionality and PayPal API packages without touching the running functionality. Simplicity and configurability are our guiding principles.
Note: This project is now actively maintained at another location: https://github.com/geekstore/ppbox. So please fork/follow the new location to stay updated.
- PHP 5.4.3
- curl extension for PHP
For deploying this project on your machine, you would need a web server capable of running PHP applications. We have tested this on Apache 2.2.22. You also need to configure Apache to run PHP. Once you are ready, please follow these steps:
- Clone the repository
- Deploy the ppbox folder in the document root of your web server
- Configure path and (optionally) other log settings in controller/config/log4php_config.xml
- Make your logs directory writable by running
chmod 777 full/path/to/your/logs/directory - Start your web server
Important Note: Most of the functionality will not work unless logs folder is writable.
Now, the framework will be ready to accept REST calls. Please read documentation for the supported API and how to make calls.
In case you find any problems, do check the project wiki where we add any solutions we find to known problems related to deployment etc.
More specific documentation can be found by navigating inside individual folders. But here's a quick index of most important pages:
| 1. | Component Diagram |
| 2. | The REST API |
| 3. | Configuration |
| 4. | Checkout Module |
| 8. | Status Module |
| 9. | Packages |
This framework has two main types of components from developer perspective - modules and packages
Modules - These represent business actions like checkout, checkin etc.
Packages - These represent PayPal API packages like PaymentsPro, Adaptive etc.
The intention behind this kind of separation is to provide flexibility for the user to configure (switch on/off) individual business functionalities without requiring the knowledge of PayPal APIs. On the other hand, to provide user the flexibility to configure individual PayPal API's (change end points, switch on/off) without modifying configuration of business functionalities.
We are working on providing a reference implementation application which would use this framework to process payments of a typical merchant's shopping cart. We will update it soon.
-
Reporting bugs/ feature requests:
Please report all bugs/feature requests to vaibhav276@yahoo.co.in -
Adding new functionality:
Please refer to below pages for adding new functionality to this framework:
We are using Apache 2.0 license for this project for providing the source code only and we do not assume any additional liability. Please be advised that since this framework is capable of handling personal and financial information of your customers, you need to comply with relevant guidelines. Do your groundwork before deploying this in production.