xe/xecd-rates-client

XECD REST Client

v0.1.1 2017-09-14 21:44 UTC

Requires

• php: >=5.6.0
• goaop/framework: ^2.0
• symfony/property-access: ^3.0|^2.8
• symfony/serializer: ^3.0|^2.8
• xe/framework-base-client: ^0.1
• xe/xecd-rates-core-component: ^0.1

Requires (Dev)

• phpunit/phpunit: ^5.7

MPL-2.0

• XE.com Inc. Development Team

• rest
• client
• Guzzle
• rates
• xe
• xecd

README

XE Currency Data Client - PHP

XE.com Inc. is the World's Trusted Currency Authority. This project provides an SDK to interface with our XE Currency Data (XECD) product.

XE Currency Data is a REST API that gives you access to daily or live rates and historic mid-market conversion rates between all of our supported currencies.

You will need an api key and secret to use this sdk. Sign up for a free trial or register for a full account.

Installation

The preferred way to install this package is through composer.

composer require xe/xecd-rates-client

This package follows semantic versioning.

Usage

<?php
require 'vendor/autoload.php';

use Xe\Xecd\Client\Rates\XecdRatesClientAspectKernel;
use Xe\Xecd\Client\Rates\Exception\XecdRatesException;
use GuzzleHttp\Exception\RequestException;

XecdRatesClientAspectKernel::getInstance()->init([
    'cacheDir' => '/your/cache/directory',
]);

$xecdRatesClient = XecdRatesClient::create(<YOUR_ACCOUNT_ID>, <YOUR_API_KEY>);

try
{
    $conversions = $xecdRatesClient->convertFrom(new Currency('CAD'), Currencies::wildcard(), 12345.67)->getBody();
    foreach ($conversions->getConversions() as $currency => $currencyConversions) {
        foreach ($currencyConversions as $timestamp => $conversion) {
            echo "{$conversion->getFromAmount()} {$conversion->getFromCurrency()} = {$conversion->getToAmount()} {$conversion->getToCurrency()}\n";
        }
    }
} catch (XecdRatesException $e) {
    // API errors with error code.
} catch (Exception $e) {
    // ALl other errors, such as connection timeout errors.
}

Documentation

Technical Specifications

Contributing

xecd-rates-client-php is an open-source project. Submit a pull request to contribute!

Testing

cd xecd-rates-client-php
composer install

# Unit tests.
phpunit --testsuite Unit

# Integration tests.
export XECD_RATES_API_ACCOUNT_ID=<YOUR_API_ACCOUNT_ID>
export XECD_RATES_API_KEY=<YOUR_API_KEY>
phpunit --testsuite Integration

Security Issues

If you discover a security vulnerability within this package, please DO NOT publish it publicly. Instead, contact us at security [at] xe.com. We will follow up with you as soon as possible.

About Us

XE.com Inc. is The World's Trusted Currency Authority. Development of this project is led by the XE.com Inc. Development Team and supported by the open-source community.