Welcome to the Shopping Feed PHP SDK

Install

In your project root repository run bash composer require shoppingfeed/php-sdk
Install a http client of your choice, we recommend using GuzzleHttp 6 as the SDK embed an adapter for this client. bash composer require guzzlehttp/guzzle ^6.3 You can also develop your own adapter, if you already have a http client library in your project (see the http adapter documentation for more information).

This will load the SDK library into the vendor repository.
And thanks to PSR-4 specification you should be able to access the SDK under the namespace \ShoppingFeed\Sdk., _(*1)

Basic usage

Here are the three basic steps to use the SDK : 1. Authentication to start a new session 2. Retrieve the store(s) you want to manage from the session 3. Manage resources, _(*2)

Authentication against the API

The Shopping Feed API requires that you are authenticated to perform any calls., _(*3)

In order to make authenticated call, you should build the client like so:, _(*4)

<?php
namespace ShoppingFeed\Sdk;

// Setup credentials to connect to the API, and create session
$credential = new Credential\Token('api-token');
/** @var \ShoppingFeed\Sdk\Api\Session\SessionResource $session */
$session = Client\Client::createSession($credential);

Accessing your stores

/** @var \ShoppingFeed\Sdk\Api\Session\SessionResource $session */
$store = $session->selectStore(1276);
$store->getName(); // test-store
$store->getId(); // 1276
// ... and so on

If you manage more than one store, you can use the store collection object, _(*5)

/** @var \ShoppingFeed\Sdk\Api\Session\SessionResource $session */
// Get store collection
$stores = $session->getStores();
// Count the number of stores [int]
$stores->count();
// Get a particular store
$store = $stores->select('id-or-store-name');
// Loop over available stores
foreach ($stores as $store) {
    $store->getName(); 
}