dfcplc/dfcapi-php

DFC API - PHP

1.0.2 2016-03-03 14:37 UTC

Requires

• php: >=5.4.0
• ext-curl: *
• ext-json: *
• mashape/unirest-php: 2.*

MIT

• Debit Finance Collections Plc

• api
• direct debit
• dfc
• dd

README

The DFC API is a Restful API which has been built to facilitate the ability to Setup/Ammend/Cancel & View Direct Debits with Debit Finance Collections Plc

Install with Composer

If you're using Composer to manage dependencies, you can the DFC API Client Library with it.

{
  "require" : {
    "dfcplc/dfcapi-php" : "dev-master"
  },
  "autoload": {
    "psr-0": {"Dfcapi": "lib/"}
  }
}

Install source from GitHub

The DFCAPI-PHP Client Library requires PHP v5.3+. Download the PHP library from Github, and require in your script like so:

To install the source code:

$ git clone [e-mail]:dfcplc/dfcapi-php.git 

And include it in your scripts:

require_once '/path/to/dfcapi-php/lib/Dfcapi.php';

Checking API Credentials

So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:

$dfcapi = new Dfcapi();
$response = $dfcapi->CheckApiKey('TEST-TEST-TEST-TEST','a94a8fe5ccb19ba61c4c0873d391e987982fbbd3');

var_dump($response); // API Credential Check Response (true or false)

Extra Details

When calling the API, additional details can be retrieved using the below methods:

$dfcapi = new Dfcapi();

$dfcapi->getErrors(); //Array of returned errors from the API Call

$dfcapi->getResponseCode(); //HTTP Response Code (200 = OK)

$dfcapi->getResponseBody(); //HTTP Response Body (Object)

$dfcapi->getResponseBodyRaw(); //HTTP Response Body (Raw)

$dfcapi->getResponseHeaders(); //HTTP Response Headers (Array)

### Thanks Thanks go out to: * [thefosk](https://github.com/thefosk) @ [mashape.com](https://mashape.com) - Unirest Restful Library