enm/shopware-sdk

An implementation for accessing the Shopware api

Shopware SDK

, _(*1)

This library provides an extendable abstraction for the Shopware REST-API. The provided default implementation is based on jms/serializer and guzzlehttp/guzzle. All provided interfaces can be used without installing Guzzle or the Serializer., _(*2)

Installation

composer require enm/shopware-sdk

If you want to use the default implementation you also have to run:, _(*3)

composer require guzzlehttp/guzzle

composer require jms/serializer

Usage

\Doctrine\Common\Annotations\AnnotationRegistry::registerAutoloadNamespace(
    'JMS\Serializer\Annotation', __DIR__.'/../vendor/jms/serializer/src'
);

$client = new \Enm\ShopwareSdk\Http\GuzzleAdapter(new \GuzzleHttp\Client());
$client->withConfig('http://example.com', 'user', 'apiKey');

$serializer = \JMS\Serializer\SerializerBuilder::create()->build();


$entryPoint = new \Enm\ShopwareSdk\EntryPoint($client);

$entryPoint->addSerializer(new \Enm\ShopwareSdk\Response\ArticleHandler($serializer));
$entryPoint->addSerializer(new \Enm\ShopwareSdk\Response\OrderHandler($serializer));

$entryPoint->addDeserializer(new \Enm\ShopwareSdk\Response\ArticleHandler($serializer));
$entryPoint->addDeserializer(new \Enm\ShopwareSdk\Response\OrderHandler($serializer));

OR, _(*4)

$entryPoint = \Enm\ShopwareSdk\EntryPoint::buildDefault('http://example.com', 'user', 'apiKey');

The endpoints can be called like this:, _(*5)

$entryPoint->articles()->findAll();
$entryPoint->articles()->find(1);

$entryPoint->orders()->findAll();
$entryPoint->orders()->find(1);

Concepts

Entry Point

An entry point should implement \Enm\ShopwareSdk\EntryPointInterface and is responsible for creation and management of endpoint instances., _(*6)

The default entry point (\Enm\ShopwareSdk\EntryPoint) needs a configured http client and a serializer and deserializer for each endpoint., _(*7)

A serializer can be added by calling:, _(*8)

    $entryPoint->addSerializer($serializer);

A deserializer can be added by calling:, _(*9)

    $entryPoint->addDeserializer($serializer);

Endpoints

An endpoint is responsible for providing access to a specific sub part of the shopware api., _(*10)

The ArticelEndpoint for example is responsible to access all api routes under /api/articles., _(*11)

All default endpoints extending the abstract endpoint which needs a http client and a response handler., _(*12)

(HTTP-)Client

The http client is responsible to request an api route and create a PSR-7 response object with the result., _(*13)

The default client (\Enm\ShopwareSdk\Http\GuzzleAdapter) uses the Guzzle http client., _(*14)

Serializer / Deserializer

A serializer is responsible for converting a given PHP object into the needed json string., _(*15)

A deserializer is responsible for converting the json response into the needed PHP object., _(*16)

The default handlers (combination of serializer and deserializer) are based on JMS Serializer and can be added by calling addDefaultSerializers and addDefaultDeserializers from the default EntryPoint., _(*17)

If you don't want to use it, you can write your own which have to implement \Enm\ShopwareSdk\Serializer\JsonSerializerinterface and/or \Enm\ShopwareSdk\Serializer\JsonDeserializerinterface., _(*18)

A (de)serializer must return all supported types if getSupportedTypes is called. A type is the class name of the models interface, for example: \Enm\ShopwareSdk\Model\Order\OrderInterface for the OrderEnpoint., _(*19)