README

A PHP client for BaseKit's REST API. This client will provide documentation of the services available from the BaseKit API, describing URIs, HTTP methods and input parameters.

Installation

The recommended way of including this package in your project is by using Composer. Add it to the require section of your project's composer.json.

"basekit/php-api-client": "dev-master"

Usage

<?php

require 'vendor/autoload.php';
use BaseKit\Api\Client;

$client = Client::factory(
    array(
        'base_url'        => 'http://api.example.org',
        'consumer_key'    => '1234567890',
        'consumer_secret' => 'qwertyuiop',
        'token'           => 'asdfghjkl',
        'token_secret'    => 'zxcvbnm',
    )
);

$createSite = $client->getCommand(
    'CreateSite',
    array(
        'accountHolderRef' => 123,
        'brandRef' => 456,
        'domain' => 'test.example.org',
    )
);
$response = $createSite->execute();
print_r($response);

Contributing

This project adheres to the PSR2 coding style guide. Checking your contribution's correctness is easy.

$ make lint

There's a very small unit test suite, using PHPUnit. Making sure you haven't broken any tests is easy too.

$ make test

License

This software is released under the MIT License.