asgoodasnu/afterbuyapi

The WkAfterbuyApi provides a Symfony2 service to interact with the Afterbuy XML API

This package's canonical repository appears to be gone and the package has been frozen as a result.

v1.3.5 2019-03-22 13:59 UTC

Requires

• php: ~5.4
• guzzlehttp/guzzle: >=5.0,<7.0
• jms/serializer: ^1.1
• symfony/framework-bundle: ~2.6
• symfony/yaml: ~2.6

Requires (Dev)

• matthiasnoback/symfony-dependency-injection-test: ~0.7
• phpunit/phpunit: ~4.8
• symfony/monolog-bundle: ~2.6

MIT

• Github Community
• Annika Flemming
• Thomas Stägemann

• afterbuy

README

The WkAfterbuyApiBundle provides a Symfony2 service to interact with the Afterbuy XML API using Guzzle.

Installation

Require the bundle and its dependencies with composer:

$ composer require asgoodasnu/afterbuyapi

Register the bundle:

// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        new Wk\AfterbuyApiBundle\WkAfterbuyApiBundle(),
    );
}

Overwrite the parameters defined in Wk\AfterbuyApiBundle\App\parameters.yml with your own Afterbuy credentials in your project's parameters.yml:

# parameters.yml
locale: en
afterbuy_partner_id: 123
afterbuy_partner_password: pass
afterbuy_user_id: user
afterbuy_user_password: pass

Usage

Interaction with the Afterbuy XML API is done via the service wk_afterbuy_api.xml.client.

Retrieving a list of sold items from Afterbuy:

$client = $container->get('wk_afterbuy_api.xml.client');
$soldItems = $client->getSoldItems($filters, $orderDirection, $maxSoldItems, $detailLevel);

The response will be an instance of Wk\AfterbuyApiBundle\Model\XmlApi\GetSoldItems\GetSoldItemsResponse and provides methods to traverse the XML sent back from Afterbuy such as fetching the orders:

$orders = $soldItems->getResult()->getOrders();

Provide an array of filters defined in Afterbuy, for example a DateFilter or a DefaultFilter. The models for these filters can be found in Wk\AfterbuyApiBundle\Model\XmlApi\GetSoldItems\Filter.

$dateFilter = (new DateFilter(DateFilter::FILTER_AUCTION_END_DATE))
                ->setDateFrom(new DateTime('2000-01-01 00:00:00'))
                ->setDateTo(new DateTime('2000-01-10 00:00:00'));
            
$defaultFilter = new DefaultFilter(DefaultFilter::FILTER_COMPLETED_AUCTIONS);

Updating sold items on Afterbuy:

$order = new \Wk\AfterbuyApiBundle\Model\XmlApi\UpdateSoldItems\Order();
$order->setOrderId(1234567890)
      ->setUserDefinedFlag(12345)
      ->setInvoiceMemo("You didn't read the memo? You are fired!");
$client = $container->get('wk_afterbuy_api.xml.client');
$client->updateSoldItems(array($orders));

The response will be an instance of Wk\AfterbuyApiBundle\Model\XmlApi\UpdateSoldItems\UpdateSoldItemsResponse.

Dependencies

• jms/serializer - Allows you to easily serialize, and deserialize data of any complexity
• guzzlehttp/guzzle - Guzzle is a PHP HTTP client library
• symfony/yaml - Symfony Yaml Component
• symfony/monolog - Symfony MonologBundle
• symfony/framework-bundle - Symfony FrameworkBundle

PHPUnit Tests

You can run the tests using the following command:

$ vendor/bin/phpunit

Resources

Symfony 2

http://symfony.com

Afterbuy XML Interface Documentation:

http://xmldoku.afterbuy.de/dokued/