This repository has been archived on 2026-04-06. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
PayPal-PHP-SDK/README.md
2013-04-26 16:42:04 +05:30

66 lines
1.9 KiB
Markdown

REST API SDK for PHP (V0.6.0) [![Build Status](https://travis-ci.org/paypal/rest-api-sdk-php.png?branch=master)](https://travis-ci.org/paypal/rest-api-sdk-php)
==============================
This repository contains PayPal's PHP SDK and samples for REST API.
Prerequisites
-------------
* PHP 5.3 or above
* curl, json & openssl extensions must be enabled
* composer for running the sample out of the box (See http://getcomposer.org)
Running the sample
------------------
* Ensure that you have composer installed on your machine.
* Navigate to the samples folder and run 'composer update'.
* Optionally, update the sdk_config.ini file with your own client Id and client secret.
* Run any of the command line samples in the folder to see what the APIs can do.
Usage
-----
To write an app that uses the SDK
* Copy the composer.json file from the sample folder over to your project and run 'composer update' to fetch all
dependencies
* Copy the sample configuration file sdk_config.ini to a location of your choice and let the SDK know your config path using the following define directive
```php
define('PP_SDK_CONFIG_PATH', /path/to/your/sdk_config.ini);
```
* Obtain your clientId and client secret from the developer portal and add them to your config file
* Now you are all set to make your first API call. Create a resource object as per your need and call the relevant operation or invoke one of the static methods on your resource class.
```php
$payment = new Payment();
$payment->setIntent("Sale");
...
$payment->create();
*OR*
$payment = Payment::get('payment_id');
```
These examples pick the client id / secret automatically from your config file. You can also set API credentials dynamically. See the sample code for how you can do this.
Contributing
------------
More help
---------
* API Reference
* Reporting issues / feature requests