library php-openbazaar-api

davalb/php-openbazaar-api

The OpenBazaar API makes it easy for developers to communicate with the OpenBazaar marketplace

OpenBazaar Api

This library is a PHP 5.x implementation of the OpenBazaar REST API Documentation POST calls, OpenBazaar REST API Documentation GET calls The OpenBazaar API is a REST-based interface. By using this library you don't have to worry about communicating with the API: all the hard work has already be done., _(*1)

This API is build upon the shoulders of a giant: Guzzle 5.0. This is an absolutely awesome library., _(*2)

Installation

Start by installing composer. Next do:, _(*3)

$ composer require davalb/php-openbazaar-api

Requirements

PHP >=5.4.0, _(*4)

Usage

Creating a new instance is as simple as:, _(*5)

 'http://your_ip_or_domain_here:18469/',
    ]
);
$response = $service->login([
    'username' => 'your_username_here',
    'password' => 'your_password_here',
]);
// get Profile will return your profile info
$result = $service->getProfile();
// get Listings for the store with the given guid
$result = $service->getListings([
    'guid' => 'a06aa22a38f0e62221ab74464c311bd88305f88c'
]);
// follow another page
$result = $service->follow(
    ['guid' => 'a06aa22a38f0e62221ab74464c311bd88305f88c']
);
// change your username
$result = $service->changeProfile(
    ['name' => 'New Name']
);
// set social account
$result = $service->createSocialAccount([
    'account_type' => 'twitter',
    'username' => 'user',
]);

// upload an image
$imageurl = "https://placekitten.com/200/300";
$imagedata = file_get_contents($imageurl);
$base64 = base64_encode($imagedata);
$image = [
    'image' => $base64
];
$imageResult = $this->service->uploadImage($image);

// create a new contract (i.e. a new product offering)
$contract = [
    'expiration_date' => '',
    'metadata_category' => 'physical good',
    'title' => 'Product Title',
    'currency_code' => 'EUR',
    'description' => 'A Description about the product',
    'price' => '9.90',
    'process_time' => '1',
    'nsfw' => 'false',
    'terms_conditions' => '',
    'shipping_origin' => 'GERMANY',
    'ships_to' => 'ALL',
    'est_delivery_domestic' => '2 Business Days',
    'est_delivery_international' => '7-21 Business Days',
    'returns' => '',
    'shipping_currency_code' => 'EUR',
    'shipping_domestic' => 6,
    'shipping_international' => 12,
    'keywords' => 'vinyl',
    'category' => '',
    'condition' => 'New',
    'sku' => '',
    'free_shipping' => 'false',
    'images' => $imageResult['image_hashes'][0],
    'moderators' => 'e85ac56a60d01fa5ad20b3194bfc1c593db17cba',
    'contract_id' => '',
];
$result = $this->service->createContract($contract);
?>

It is necessary to run the login first. After that you can run more api-calls without worrying about the authentication, since the cookie is persisted., _(*6)

More info and plugins

For more information about Guzzle and its plugins checkout the docs., _(*7)

Contributing

Implemented a missing call? PR's are welcome! The project follows the cakephp coding standards. Plese install and use the php code sniffer before sending a pull request, _(*8)

phpcs --standard=cakephp php-openbazaar-api/

Also please provide tests for code that you write. Tests can be run like this, _(*9)

bin/phpunit davalb/php-openbazaar-api/tests/