ZendService\Amazon

ZendServiceAmazon

Introduction

ZendService\Amazon is a simple API for using Amazon web services. ZendService\Amazon has two APIs: a more traditional one that follows Amazon’s own API, and a simpler “Query API” for constructing even complex search queries easily.

ZendService\Amazon enables developers to retrieve information appearing throughout Amazon.com web sites directly through the Amazon Web Services API. Examples include:

  • Store item information, such as images, descriptions, pricing, and more
  • Customer and editorial reviews
  • Similar products and accessories
  • Amazon.com offers
  • ListMania lists

In order to use ZendService\Amazon, you should already have an Amazon developer API key aswell as a secret key. To get a key and for more information, please visit the Amazon Web Services web site. As of August 15th, 2009 you can only use the Amazon Product Advertising API through ZendService\Amazon, when specifying the additional secret key.

Note

Attention

Your Amazon developer API and secret keys are linked to your Amazon identity, so take appropriate measures to keep them private.

Search Amazon Using the Traditional API

In this example, we search for PHP books at Amazon and loop through the results, printing them.

1
2
3
4
5
6
$amazon = new ZendService\Amazon\Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array('SearchIndex' => 'Books',
                                     'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}

Search Amazon Using the Query API

Here, we also search for PHP books at Amazon, but we instead use the Query API, which resembles the Fluent Interface design pattern.

1
2
3
4
5
6
7
8
$query = new ZendService\Amazon\Query('AMAZON_API_KEY',
                                       'US',
                                       'AMAZON_SECRET_KEY');
$query->category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '<br />';
}

Country Codes

By default, ZendService\Amazon connects to the United States (“US”) Amazon web service. To connect from a different country, simply specify the appropriate country code string as the second parameter to the constructor:

Choosing an Amazon Web Service Country

1
2
// Connect to Amazon in Japan
$amazon = new ZendService\Amazon\Amazon('AMAZON_API_KEY', 'JP', 'AMAZON_SECRET_KEY');

Note

Country codes

Valid country codes are: CA, DE, FR, JP, UK, and US.

Looking up a Specific Amazon Item by ASIN

The itemLookup() method provides the ability to fetch a particular Amazon item when the ASIN is known.

Looking up a Specific Amazon Item by ASIN

1
2
$amazon = new ZendService\Amazon\Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$item = $amazon->itemLookup('B0000A432X');

The itemLookup() method also accepts an optional second parameter for handling search options. For full details, including a list of available options, please see the relevant Amazon documentation.

Note

Image information

To retrieve images information for your search results, you must set ResponseGroup option to Medium or Large.

Performing Amazon Item Searches

Searching for items based on any of various available criteria are made simple using the itemSearch() method, as in the following example:

Performing Amazon Item Searches

1
2
3
4
5
6
$amazon = new ZendService\Amazon\Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array('SearchIndex' => 'Books',
                                     'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}

Using the ResponseGroup Option

The ResponseGroup option is used to control the specific information that will be returned in the response.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$amazon = new ZendService\Amazon\Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array(
    'SearchIndex'   => 'Books',
    'Keywords'      => 'php',
    'ResponseGroup' => 'Small,ItemAttributes,Images,SalesRank,Reviews,' .
                       'EditorialReview,Similarities,ListmaniaLists'
    ));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}

The itemSearch() method accepts a single array parameter for handling search options. For full details, including a list of available options, please see the relevant Amazon documentation

Tip

The ZendServiceAmazonQuery class is an easy to use wrapper around this method.

Using the Alternative Query API

Introduction

ZendService\Amazon\Query provides an alternative API for using the Amazon Web Service. The alternative API uses the Fluent Interface pattern. That is, all calls can be made using chained method calls. (e.g., $obj->method()->method2($arg))

The ZendService\Amazon\Query API uses overloading to easily set up an item search and then allows you to search based upon the criteria specified. Each of the options is provided as a method call, and each method’s argument corresponds to the named option’s value:

Search Amazon Using the Alternative Query API

In this example, the alternative query API is used as a fluent interface to specify options and their respective values:

1
2
3
4
5
6
$query = new ZendService\Amazon\Query('MY_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$query->Category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '<br />';
}

This sets the option Category to “Books” and Keywords to “PHP”.

For more information on the available options, please refer to the relevant Amazon documentation.

ZendServiceAmazon Classes

The following classes are all returned by ZendServiceAmazon::itemLookup() and ZendServiceAmazon::itemSearch():

ZendServiceAmazonItem

ZendService\Amazon\Item is the class type used to represent an Amazon item returned by the web service. It encompasses all of the items attributes, including title, description, reviews, etc.

ZendServiceAmazonItem::asXML()

string:asXML()

Return the original XML for the item

Properties

ZendService\Amazon\Item has a number of properties directly related to their standard Amazon API counterparts.

Back to Class List

ZendServiceAmazonImage

ZendService\Amazon\Image represents a remote Image for a product.

Properties

ZendServiceAmazonImage Properties
Name Type Description
Url ZendUriUri Remote URL for the Image
Height int The Height of the image in pixels
Width int The Width of the image in pixels

Back to Class List

ZendServiceAmazonResultSet

ZendService\Amazon\ResultSet objects are returned by ZendServiceAmazon::itemSearch() and allow you to easily handle the multiple results returned.

Note

SeekableIterator

Implements the SeekableIterator for easy iteration (e.g. using foreach), as well as direct access to a specific result using seek().

ZendServiceAmazonResultSet::totalResults()

int:totalResults() Returns the total number of results returned by the search

Back to Class List

ZendServiceAmazonOfferSet

Each result returned by ZendServiceAmazon::itemSearch() and ZendServiceAmazon::itemLookup() contains a ZendService\Amazon\OfferSet object through which pricing information for the item can be retrieved.

ZendServiceAmazonOffer

Each offer for an item is returned as an ZendService\Amazon\Offer object.

ZendServiceAmazonOffer Properties

Properties
Name Type Description
MerchantId string Merchants Amazon ID
MerchantName string Merchants Amazon Name. Requires setting the ResponseGroup option to OfferFull to retrieve.
GlancePage string URL for a page with a summary of the Merchant
Condition string Condition of the item
OfferListingId string ID of the Offer Listing
Price int Price for the item
CurrencyCode string Currency Code for the price of the item
Availability string Availability of the item
IsEligibleForSuperSaverShipping boolean Whether the item is eligible for Super Saver Shipping or not

Back to Class List

ZendServiceAmazonSimilarProduct

When searching for items, Amazon also returns a list of similar products that the searcher may find to their liking. Each of these is returned as a ZendService\Amazon\SimilarProduct object.

Each object contains the information to allow you to make sub-sequent requests to get the full information on the item.

Properties

ZendServiceAmazonSimilarProduct Properties
Name Type Description
ASIN string Products Amazon Unique ID (ASIN)
Title string Products Title

Back to Class List

ZendServiceAmazonAccessories

Accessories for the returned item are represented as ZendService\Amazon\Accessories objects

Properties

ZendServiceAmazonAccessories Properties
Name Type Description
ASIN string Products Amazon Unique ID (ASIN)
Title string Products Title

Back to Class List

ZendServiceAmazonCustomerReview

Each Customer Review is returned as a ZendService\Amazon\CustomerReview object.

Properties

ZendServiceAmazonCustomerReview Properties
Name Type Description
Rating string Item Rating
HelpfulVotes string Votes on how helpful the review is
CustomerId string Customer ID
TotalVotes string Total Votes
Date string Date of the Review
Summary string Review Summary
Content string Review Content

Back to Class List

ZendServiceAmazonEditorialReview

Each items Editorial Reviews are returned as a ZendService\Amazon\EditorialReview object

Properties

ZendServiceAmazonEditorialReview Properties
Name Type Description
Source string Source of the Editorial Review
Content string Review Content

Back to Class List

ZendServiceAmazonListmania

Each results List Mania List items are returned as ZendService\Amazon\Listmania objects.

Properties

ZendServiceAmazonListmania Properties
Name Type Description
ListId string List ID
ListName string List Name

Back to Class List

blog comments powered by Disqus