Skip to content

Commit

Permalink
Merge pull request #29 from gauravmokhasi/patch-1
Browse files Browse the repository at this point in the history
formatting fix
  • Loading branch information
amie-gao authored Apr 10, 2017
2 parents 0f19074 + 19d456b commit 730219c
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
#CyberSource PHP Client

# CyberSource PHP Client
This is the PHP client for the [CyberSource SOAP Toolkit API](http://www.cybersource.com/developers/getting_started/integration_methods/soap_toolkit_api).

[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-php.png?branch=master)]
(https://travis-ci.org/CyberSource/cybersource-sdk-php)
[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-php.png?branch=master)](https://travis-ci.org/CyberSource/cybersource-sdk-php)

##Packagist
## Packagist
The cybersource/sdk-php is available at [Packagist](https://packagist.org/packages/cybersource/sdk-php).
If you want to install SDK from Packagist,add the following dependency to your application's 'composer.json'.

"require": {
"cybersource/sdk-php": "*"
},

##Prerequisites
```json
"require": {
"cybersource/sdk-php": "*"
},
```
## Prerequisites

- PHP 5.3 or above
- [curl](http://php.net/manual/en/book.curl.php), [openssl](http://php.net/manual/en/book.openssl.php), [soap](http://php.net/manual/en/book.soap.php) extensions must be enabled
- A CyberSource account. You can create an evaluation account [here](http://www.cybersource.com/register/).
- A CyberSource transaction key. You will need to set your merchant ID and transaction key in the ````cybs.ini```` file in ````lib/conf````. Instructions on obtaining a transaction key can be found [here](http://www.cybersource.com/developers/integration_methods/simple_order_and_soap_toolkit_api/soap_api/html/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Intro.04.3.html).


##Installation

## Installation
You can install the client either via [Composer](https://getcomposer.org/) or manually. Before installing, make sure to configure the merchant ID, transaction key, and the appropriate WSDL file URL in ````cybs.ini````. By default, the WSDL file for the client is for API version 1.120 (the latest when this package was updated). Available WSDL file URLs can be browsed at the following locations:

- [test](https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/)
- [live](https://ics2ws.ic3.com/commerce/1.x/transactionProcessor/)

###Installing with Composer
### Installing with Composer
You'll first need to make sure you have Composer installed. You can follow the instructions on the [official web site](https://getcomposer.org/download/). Once Composer is installed, you can enter the project root and run:
```
composer.phar install
Expand All @@ -39,18 +35,17 @@ Then, to use the client, you'll need to include the Composer-generated autoload
require_once('/path/to/project/vendor/autoload.php');
```

###Manual installation
### Manual installation
To use the client manually, include the CyberSource client in your project:

```php
require_once('/path/to/project/lib/CybsSoapClient.php');
```


##Getting Started
## Getting Started
The PHP client will generate the request message headers for you, and will contain the methods specified by the WSDL file.

###Creating a simple request
### Creating a simple request
The main method you'll use is ````runTransaction()````. To run a transaction, you'll first need to construct a client to generate a request object, which you can populate with the necessary fields (see [documentation](http://www.cybersource.com/developers/integration_methods/simple_order_and_soap_toolkit_api/soap_api/html/wwhelp/wwhimpl/js/html/wwhelp.htm#href=Intro.04.4.html) for sample requests). The object will be converted into XML, so the properties of the object will need to correspond to the correct XML format.

```php
Expand All @@ -68,7 +63,7 @@ $request->card = $card;
$reply = $client->runTransaction($request);
```

###Creating a request from XML
### Creating a request from XML
You can create a request from XML either in a file or from an XML string. The XML request format is described in the **Using XML** section [here](http://apps.cybersource.com/library/documentation/dev_guides/Simple_Order_API_Clients/Client_SDK_SO_API.pdf). Here's how to run a transaction from an XML file:

```php
Expand All @@ -86,7 +81,7 @@ $client = new CybsSoapClient();
$client->runTransactionFromXml($xml);
```

###Using name-value pairs
### Using name-value pairs
In order to run transactions using name-value pairs, make sure to set the value for the WSDL for the NVP transaction processor in ````cybs.ini````. Then use the ````CybsNameValuePairClient```` as so:

```php
Expand All @@ -99,7 +94,7 @@ $request['merchantReferenceCode'] = $'my_reference_code';
$reply = $client->runTransaction($request);
```

##Running the Samples
## Running the Samples
After configuring your merchant ID and transaction key in ````cybs.ini````, the samples in the ````samples```` directory can be run from the project root. For example:

```
Expand All @@ -108,7 +103,7 @@ php samples/Sale.php

The samples will output the response object for each request if successful. Note that the samples contain test data and should not be run in a live environment.

##Tests
## Tests

In order to run tests, you'll need [PHPUnit](https://phpunit.de). You'll also need to use [Composer](https://getcomposer.org/) for autoloading. If you used Composer to install the client, this should already be set up. Otherwise, to use Composer for autoloading only, from the project root run
```
Expand All @@ -117,7 +112,7 @@ composer.phar dump-autoload

If you installed PHPUnit with Composer, run the tests from the project root with the command ````vendor/bin/phpunit````.

##Documentation
## Documentation

For more information about CyberSource services, see <http://www.cybersource.com/developers/documentation>

Expand Down

0 comments on commit 730219c

Please sign in to comment.