README

The Unlimit API uses HTTP verbs and a RESTful endpoint structure. Request and response payloads are formatted as JSON.

API version: 3.0
PHP SDK version: 3.68.8

For more information, please visit https://integration.cardpay.com

Requirements

PHP 5.6 or later
curl, json, openssl extensions

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cardpay/php-sdk-v3.git"
    }
  ],
  "require": {
    "cardpay/php-sdk-v3": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files, run composer install and include autoload.php:

require_once('./vendor/autoload.php');

Proxy Usage

SDK will automatically use the proxy if the HTTPS_PROXY or HTTP_PROXY environment variable is set.

Getting Started

Important: please note that current implementation is using temporary files storage (see FileTokensStorageApi), to save, read and delete (if needed) the API tokens. You may implement another tokens storage (session, database, Memcached, Redis, etc) by implementing TokensStorageApi interface.

In order to obtain the API tokens please use AuthApiClient. It requires API terminal code and password, provided by Unlimit.

Please follow the installation procedure and then run the following:

<?php

use Cardpay\api\AuthApiClient;
use Cardpay\api\FileTokensStorageApi;

$fileTokensStorageApi = new FileTokensStorageApi($host, $terminalCode);
$authApiClient = new AuthApiClient($host, $terminalCode, $password, $fileTokensStorageApi);

/** @var ApiTokens $apiTokens */
$apiTokens = $authApiClient->obtainApiTokens();

$accessToken = $apiTokens->getAccessToken();
$refreshToken = $apiTokens->getRefreshToken();
$tokenType = $apiTokens->getTokenType();

Tests

Open ./test/Config.php and set terminal code, password and terminal currency.

To run the unit tests:

composer install
./vendor/bin/phpunit --configuration ./phpunit.xml

Documentation for models

Author

support@unlimit.com

kubinyete / unlimit-php-sdk-v3

Maintainers

Details