bynder/bynder-php-sdk

1.0.6 2018-06-20 13:48 UTC

README

The main goal of this SDK is to speed up the integration of Bynder customers who use PHP. Making it easier to connect to the Bynder API (http://docs.bynder.apiary.io) and executing requests on it.

Requirements and dependencies

The PHP SDK requires the following in order to fully work:

  • PHP >= 5.6, older versions of PHP not recommended
  • curl, although you can use your own non-cURL client if you prefer

Composer should handle all the dependencies automatically.

Composer package

The Bynder PHP SDK is published as a composer package in packagist and can be found here:

https://packagist.org/packages/bynder/bynder-php-sdk

Installation

This SDK depends on a few libraries in order to work, installing it with Composer should take care of everything automatically.

To install the SDK with Composer. Run the following command at the root of the project:

composer require bynder/bynder-php-sdk

To use the SDK, we use Composer's autoload in order to include all the files automatically:

require_once('vendor/autoload.php');

How to use it

This is a simple example on how to retrieve data from the Bynder asset bank. For a more detailed example of implementation refer to the sample code.

Before executing any request to the Bynder API we need to instantiate the BynderApi class, the following example shows how to use the BynderApiFactory to construct a BynderApi instance:

    $bynderApi = BynderApiFactory::create(
        [
          'consumerKey' => BYNDER_CONSUMER_KEY,
          'consumerSecret' => BYNDER_CONSUMER_SECRET,
          'token' => BYNDER_CLIENT_KEY,
          'tokenSecret' => BYNDER_CLIENT_SECRET,
          'baseUrl' => BYNDER_URL
        ]
    );

The SDK allows the use of Guzzle request options, such as 'proxy' or 'headers', in order to accommodate specific server requirements. To do so, all we need to do is send an extra settings parameter with 'requestOptions' as key and the desired options when creating the BynderApi object.:

    $requestOptions = ['proxy' => 'http://MY-PROXY.URL:PORT_NUM'];
    $bynderApi = BynderApiFactory::create(
        [
           ...
           'requestOptions' => $requestOptions
        ]
    );

After getting the BynderApi service configured successfully we need to get an instance of the AssetBankManager in order to do any of the API calls relative to the Bynder Asset Bank module:

 $assetBankManager = $bynderApi->getAssetBankManager();

And with this, we can start our request to the API, listed in the Methods Available section following. Short example of getting all the Media Items:

 $mediaList = $assetBankManager->getMediaList();

This call will return a list with all the Media Items available in the Bynder environment. Note that some of the calls accept a query array in order to filter the results via the API call params (see Bynder API Docs) for more details. For instance, if we only wanted to retrieve 2 images here is what the call would look like:

    $mediaList = $assetBankManager->getMediaList(
        [
          'limit' => 2,
          'type' => 'image'
        ]
   );

All the calls are Asynchronous, which means they will return a Promise object, making it a bit more flexible in order to adjust to any kind of application. Again, for a more thorough example there is a sample application use case in this repo.

Methods Available

These are the methods currently available on the Bynder PHP SDK, refer to the Bynder API Docs) for more specific details on the calls.

BynderApi:

Gets an instance of the Asset Bank Manager service if already with access tokens set up. Also allows to generate and authenticate request tokens, which are necessary for the rest of the Asset Bank calls.

    getAssetBankManager();
    getRequestToken();
    authoriseRequestToken($query);
    getAccessToken();
    setAccessTokenCredentials($token, $tokenSecret);
    userLogin($username, $password);
    userLogout();

AssetBankManager:

All the Asset Bank related calls, provides information and access to Media management.

    getBrands();
    getMediaList($query);
    getMediaInfo($mediaId, $versions);
    getMetaproperties();
    getTags();
    getCategories();
    uploadFileAsync($data);
    deleteMedia($mediaId);

Tests

Install dependencies as mentioned above (which will resolve PHPUnit), then you can run the test suite:

./vendor/bin/phpunit

Or to run an individual test file:

./vendor/bin/phpunit tests/UtilTest.php