daibe/reloadly-php

A PHP library for communicating with the Reloadly API.

v1.0.7 2021-06-08 19:13 UTC

Requires

• php: ^7.2.5
• ext-json: *

Requires (Dev)

• guzzlehttp/guzzle: ^6.3 || ^7.0

Suggests

• guzzlehttp/guzzle: An HTTP client to execute the API requests

MIT

• Daibe

• rest
• api
• web service
• airtime
• Topup
• reloadly

README

Documentation

The documentation for the Reloadly API can be found here.

The PHP library documentation can be found here.

Versions

reloadly-php uses a modified version of Semantic Versioning for all changes.

Overview

Supported PHP Versions

This library supports the following PHP implementations:

• PHP 7.2
• PHP 7.3
• PHP 7.4

Installation

You can install reloadly-php via composer or by downloading the source.

Via Composer:

reloadly-php is available on Packagist as the daibe/reloadly-php package:

composer require daibe/reloadly-php

Alternatively, you can specify the reloadly-php package as a dependency in your project’s existing composer.json file:

 {
   "require": {
     "daibe/reloadly-php": "^1.0.3"
   }
}

After installing, you need to require Composer’s autoloader:

<?php

    require __DIR__.'/vendor/autoload.php';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org.

Quickstart

Instantiation

<?php

    use ReloadlyPHP\Client;
    
    // Instantiate ReloadlyPHP 
    $reloadly = new Client('yourClientId', 'yourClientSecret');

Sandbox or live production mode

<?php

    use ReloadlyPHP\Client;

    $isProd = (bool) App::environment('production'); // Laravel
    
    // Instantiate ReloadPHP 
    $reloadly = new Client('yourClientId', 'yourClientSecret', $isProd);

Check balance

// Check your account's balance using Reloadly's REST API and PHP
<?php

    use ReloadlyPHP\Client;

    $client_id      = 'ACXXXXXX'; // Your developer client secret from www.reloadly.com/dashboard
    $client_secret  = 'YYYYYY'; // Your developer client password from www.reloadly.com/dashboard
    
    try {
    
        $reloadly   = new Client($client_id, $client_secret);
        $balance    = $reloadly->getBalance();
    
        echo '<pre>';
        echo sprintf("Amount: <strong>%s</strong> <br/>", $balance->getBalance());
        echo sprintf("Currency name: <strong>%s</strong> <br/>", $balance->getCurrencyName());
        echo sprintf("Currency code: <strong>%s</strong> <br/>", $balance->getCurrencyCode());
        echo '</pre>';
        

    } catch (Exception $e) {
        echo "Exception: ".$e->getMessage();
    }

Get countries

<?php

    try {    
        $operators = $reloadly->getOperators();
        
        echo '<pre>';
        foreach ($operators as $operator) {
            echo sprintf("Operator name: <strong>%s</strong> <br/>", $operator->getName());
            echo sprintf("Operator ID: <strong>%d</strong> <br/>", $operator->getOperatorId());
        }
        echo '</pre>';
    
    } catch (Exception $e) {
        // ... 
    }

Get foreign exchange rates

<?php

    try {    
        
        $fxRate = $reloadly->getFxRate(506, 1);
    
        if ($fxRate) {
            echo sprintf("Name: <strong>%s</strong> <br/>", $fxRate->getName());
            echo sprintf("FX Rate: <strong>%s</strong> <br/>", $fxRate->getFxRate());
            echo sprintf("Currency Code: <strong>%s</strong> <br/>", $fxRate->getCurrencyCode());
            echo sprintf("Operator ID: <strong>%d</strong> <br/>", $fxRate->getOperatorId());
        }
    
    } catch (Exception $e) {
        // ... 
    }

Contributing

Anyone can contribute to improve or fix ReloadlyPHP, to do so you can either report an issue (a bug, an idea...) or fork the repository, perform modifications to your fork then request a merge.