stevenmaguire / yelp-php
A php client for consuming Yelp API
Installs: 296 861
Dependents: 0
Suggesters: 0
Security: 0
Stars: 56
Watchers: 8
Forks: 22
Open Issues: 3
Requires
- php: >=5.6.0
- guzzlehttp/oauth-subscriber: ~0.3
Requires (Dev)
- eloquent/phony: ^0.14.1
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
Suggests
- stevenmaguire/oauth2-yelp: Provides functionality to obtain OAuth2 access tokens, needed to execute Yelp API v3 codepaths
README
A PHP client for authenticating with Yelp using OAuth and consuming the API.
Install
Via Composer
$ composer require stevenmaguire/yelp-php
Usage
This package currently supports v2
and v3
(Fusion) of the Yelp API. Each version of the Yelp API maps to a different client, as the APIs are very different. Each client has separate documentation; links provided below.
Create client
Each version of the Yelp API maps to a different client, as the APIs are very different. A client factory is available to create appropriate clients.
v2 Client Example
$options = array( 'consumerKey' => 'YOUR COSUMER KEY', 'consumerSecret' => 'YOUR CONSUMER SECRET', 'token' => 'YOUR TOKEN', 'tokenSecret' => 'YOUR TOKEN SECRET', 'apiHost' => 'api.yelp.com' // Optional, default 'api.yelp.com' ); $client = \Stevenmaguire\Yelp\ClientFactory::makeWith( $options, \Stevenmaguire\Yelp\Version::TWO );
v3 Client Example
$options = array( 'accessToken' => 'YOUR ACCESS TOKEN', // Required, unless apiKey is provided 'apiHost' => 'api.yelp.com', // Optional, default 'api.yelp.com', 'apiKey' => 'YOUR ACCESS TOKEN', // Required, unless accessToken is provided ); $client = \Stevenmaguire\Yelp\ClientFactory::makeWith( $options, \Stevenmaguire\Yelp\Version::THREE );
Prior to December 7, 2017
accessToken
was required to authenticate requests. Since then,apiKey
is the preferred authentication method. This library supports bothaccessToken
andapiKey
, prioritizingapiKey
overaccessToken
if both are provided.https://www.yelp.com/developers/documentation/v3/authentication#where-is-my-client-secret-going
Get Rate Limit data from most recent request
For the v3 client, rate limiting data is avaiable after a recent request.
// $latestRateLimit will be null if an http request hasn't been successfully completed. $latestRateLimit = $client->getRateLimit(); // The maximum number of calls you can make per day $latestDailyLimit = $latestRateLimit->dailyLimit; // The number of calls remaining within the current day $latestRemaining = $latestRateLimit->remaining; // The time at which the current rate limiting window will expire as an ISO 8601 timestamp $latestResetTime = $latestRateLimit->resetTime; // The time at which the current rate limiting data was observed as an ISO 8601 timestamp $latestCreatedAt = $latestRateLimit->createdAt;
Exceptions
If the API request results in an Http error, the client will throw a Stevenmaguire\Yelp\Exception\HttpException
that includes the response body, as a string, from the Yelp API.
$responseBody = $e->getResponseBody(); // string from Http request $responseBodyObject = json_decode($responseBody);
Advanced usage
Both the v3 client and the v2 client expose some public methods that allow overiding default behavior by providing alternative HTTP clients and requests.
$client = new \Stevenmaguire\Yelp\v3\Client(array( 'accessToken' => $accessToken, )); // Create a new guzzle http client $specialHttpClient = new \GuzzleHttp\Client([ // ... some special configuration ]); // Update the yelp client with the new guzzle http client // then get business data $business = $client->setHttpClient($specialHttpClient) ->getBusiness('the-motel-bar-chicago'); // Create request for other yelp API resource not supported by yelp-php $request = $client->getRequest('GET', '/v3/some-future-endpoint'); // Send that request $response = $client->getResponse($request); // See the contents echo $response->getBody();
Upgrading with Yelp API v2 support from yelp-php 1.x
to yelp-php 2.x
// same options for all $options = array( 'consumerKey' => 'YOUR COSUMER KEY', 'consumerSecret' => 'YOUR CONSUMER SECRET', 'token' => 'YOUR TOKEN', 'tokenSecret' => 'YOUR TOKEN SECRET', 'apiHost' => 'api.yelp.com' // Optional, default 'api.yelp.com' ); // yelp-php 1.x $client = new Stevenmaguire\Yelp\Client($options); // yelp-php 2.x - option 1 $client = \Stevenmaguire\Yelp\ClientFactory::makeWith( $options, \Stevenmaguire\Yelp\Version::TWO ); // yelp-php 2.x - option 2 $client = new \Stevenmaguire\Yelp\v2\Client($options);
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.