PHP implementation for the BitPay cryptographically secure RESTful API
PHP Other

README.md

bitpay/php-bitpay-client

GitHub license Travis Packagist Code Climate Scrutinizer Coveralls

Documentation Status Total Downloads Latest Unstable Version

This is a self-contained PHP implementation of BitPay's new cryptographically secure API: https://bitpay.com/api

Installation

Composer

Install Composer

curl -sS https://getcomposer.org/installer | php

Install via composer by hand

Add to your composer.json file by hand.

{
    ...
    "require": {
        ...
        "bitpay/php-client": "^2.2"
    }
    ...
}

Once you have added this, just run:

php composer.phar update bitpay/php-client

Install using composer

php composer.phar require bitpay/php-client:^2.2

Configuration

See https://labs.bitpay.com/t/php-bitpay-client-library-configuration/555

Usage

Autoloader

To use the library's autoloader (which doesn't include composer dependencies) instead of composer's autoloader, use the following code:

<?php
$autoloader = __DIR__ . '/relative/path/to/Bitpay/Autoloader.php';
if (true === file_exists($autoloader) &&
    true === is_readable($autoloader))
{
    require_once $autoloader;
    \Bitpay\Autoloader::register();
} else {
    throw new Exception('BitPay Library could not be loaded');
}

Documentation

Please see the docs directory for information on how to use this library and the examples directory for examples on using this library. You should be able to run all the examples by running php examples/File.php.

Reading the latest documentation at https://help.bitpay.com/8451-Implementation- might also help.

Support

License

The MIT License (MIT)

Copyright (c) 2015 BitPay, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.