Skip to content

Commit 158acc9

Browse files
committed
Updated readme
1 parent 8c16bf7 commit 158acc9

1 file changed

Lines changed: 25 additions & 4 deletions

File tree

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
#CyberSource PHP Client
22

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

55

66
##Prerequisites
77

88
- PHP 5.3 or above
99
- [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
10-
- A CyberSource merchant ID and transaction key. You will need to set these in the cybs.ini file in ````lib/conf````.
10+
- A CyberSource account. You can create an evaluation account [here](http://www.cybersource.com/register/).
11+
- 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/).
1112

1213

1314
##Installation
1415

15-
You can install the client either via [Composer](https://getcomposer.org/) or manually.
16+
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 WSDL file URL in ````cybs.ini````. By default, the WSDL file for the client is for API version 1.109.
1617

1718
###Installing with Composer
1819
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:
@@ -33,13 +34,33 @@ require_once('/path/to/project/lib/CybsSoapClient.php');
3334
```
3435

3536

37+
##Getting Started
38+
The PHP client will generate the request message headers for you, and will contain the methods specified by the WSDL file. 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/) 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.
39+
40+
```php
41+
$client = new CybsSoapClient();
42+
$request = $client->createRequest();
43+
44+
$card = new stdClass();
45+
$card->accountNumber = '4111111111111111';
46+
$card->expirationMonth = '12';
47+
$card->expirationYear = '2020';
48+
$request->card = $card;
49+
50+
// Populate $request here with other necessary properties
51+
52+
$reply = $client->runTransaction($request);
53+
```
54+
3655
##Running the Samples
37-
The samples in the ````samples```` directory can be run from the project root. For example:
56+
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:
3857

3958
```
4059
php samples/Sale.php
4160
```
4261

62+
The samples will output the response object for each request if successful.
63+
4364
##Tests
4465

4566
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

0 commit comments

Comments
 (0)