0ctobat/octobat-php

Octobat PHP Library

Octobat PHP bindings

You can sign up for an Octobat account at https://www.octobat.com., _(*1)

Requirements

PHP 5.4.0 and later., _(*2)

Composer

You can install the bindings via Composer. Run the following command:, _(*3)

composer require 0ctobat/octobat-php

To use the bindings, use Composer's autoload:, _(*4)

require_once('vendor/autoload.php');

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file., _(*5)

require_once('/path/to/octobat-php/init.php');

Dependencies

The bindings require the following extensions in order to work properly:, _(*6)

• curl, although you can use your own non-cURL client if you prefer
• json
• mbstring (Multibyte String)

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available., _(*7)

Getting Started

Simple usage looks like:, _(*8)

\Octobat\Octobat::setApiKey('sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$customer = \Octobat\Customer::create(['email' => "john.doe@gmail.com", 'name' => 'John Doe', 'billing_address_country' => 'FR']);
echo $customer;

Documentation

Please see http://v2apidoc.octobat.com/ for up-to-date documentation., _(*9)

Configuring a Logger

The library does minimal logging, but it can be configured with a [PSR-3 compatible logger][psr3] so that messages end up there instead of error_log:, _(*10)

\Octobat\Octobat::setLogger($logger);

Per-request Configuration

For apps that need to use multiple keys during the lifetime of a process, it's also possible to set a per-request key and/or account:, _(*11)

\Octobat\Customer::all([], [
    'api_key' => 'oc_test_skey...'
]);

\Octobat\Customer::retrieve("oc_cu_xxxxxxxx", [
    'api_key' => 'oc_test_skey...'
]);