yetti/api

API bindings for the Yetti platform

Yetti API PHP bindings

, _(*1)

This package contains PHP API bindings for the Yetti API., _(*2)

For more details on Yetti, please refer to http://yetti.co.uk. We welcome comments, feedback and bug reports at support@yetti.co.uk., _(*3)

Requirements

• PHP 5.3 or above.
• PHP's cURL module.

Installation

Install with composer, simply add to your composer.json:, _(*4)

"require": {
    "yetti/api": "dev-master"
}

Examples

Creating an item is simple:, _(*5)

use Yetti\API\Webservice as Webservice;
use Yetti\API\Item as Item;

Webservice::setDefaultBaseUri('https://yoursite.secure.yetti.co.uk');
Webservice::setDefaultAccessKey('your-access-key');
Webservice::setDefaultPrivateKey('your-private-key');

$item = new Item();
$item->loadTemplate(1);
$item->setName('my-big-news');
$item->setPropertyValue('Name', 'My big news..!');
$item->setPropertyValue('Body', 'I have decided to become a whale.');

echo $item->save()->success() ? 'Item saved' : 'Save failed';

And there really isn't anything much more complicated than that. Please see the included docs and tests directories for additional help and examples., _(*6)

Docs

The included documentation was generated directly from the source code using the phpDocumentor 2 tool., _(*7)

To regenerate the API docs, make sure that you have phpDocumentor 2 installed, cd to the api bindings directory then run:, _(*8)

rm -rf docs && phpdoc, _(*9)

Tests

The tests are written using PHPUnit 3.7.24., _(*10)

To run the tests, cd to the api bindings directory then run:, _(*11)

composer install
phpunit .

Contributing

The Yetti APIs are under active development, as are these PHP bindings. If you find a bug or have specific comments, please use GitHub issues. If you'd like to help us make these bindings better then feel free to fork and send pull requests., _(*12)