README.md
# Demo Client for Shutterstock API
PHP client that utilizes Guzzle to interact with the [Shutterstock API](https://developers.shutterstock.com/).
[](https://travis-ci.org/jacobemerick/php-shutterstock-api)
[](https://codeclimate.com/github/jacobemerick/php-shutterstock-api)
[](https://codeclimate.com/github/jacobemerick/php-shutterstock-api/coverage)
[](https://scrutinizer-ci.com/g/jacobemerick/php-shutterstock-api/?branch=master)
## Installation
Use [Composer](https://getcomposer.org/) to install the dependencies.
```bash
$ composer install
```
## Usage
Instantiating the client requires passing in your client id and secret, which you can register for on the [Shutterstock Developers site](https://developers.shutterstock.com/).
```php
<?php
require_once __DIR__ . '/vendor/autoload.php';
$client = new Shutterstock\Api\Client($clientId, $clientSecret);
```
Interacting with the different endpoints is as simple as reading the [API documentation](https://developers.shutterstock.com/api/v2). There are two main methods of the client to deal with - `Client::get` and `Client::post` - which take an endpoint as their first argument and the client parameters as the second.
```php
// perform an image search for puppies
$client->get('images/search', array('query' => 'puppies'));
// retrieve details for a handful of image ids
$client->get('images', array('id' => array(1, 2, 3)));
// create a lightbox
$client->post('images/collections', array('name' => 'Lightbox Name Here'));
```
Each request will return a PSR-7 response object, which you can read about on the [Guzzle/PSR7 repo](https://github.com/guzzle/psr7). The response object bodies have been decorated with a JsonSerializable interface to allow easier handling of the default API responses.
```php
$imageResponse = $client->get('images', array('id' => array(1, 2, 3)));
if ($imageResponse->getStatusCode() != 200) {
// error handler
}
$images = $imageResponse->getBody()->jsonSerialize()['data'];
// etc
```
If your application is setup to handle async CURL requests, you can also make `Client::getAsync` and `Client::postAsync` calls, which return [Guzzle Promises](https://github.com/guzzle/promises).
For more examples and a demo application using this client, see [LINK HERE].
## License
Copyright 2016 Shutterstock Images, LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.