Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcl/amazonproductapi
PHP library to retrieve products from the Amazon Product API
https://github.com/marcl/amazonproductapi
amazon-product-advertising composer php php-library simplexml
Last synced: 10 days ago
JSON representation
PHP library to retrieve products from the Amazon Product API
- Host: GitHub
- URL: https://github.com/marcl/amazonproductapi
- Owner: MarcL
- License: mit
- Created: 2012-11-13T15:27:38.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T20:34:17.000Z (over 3 years ago)
- Last Synced: 2024-10-15T01:45:34.156Z (22 days ago)
- Topics: amazon-product-advertising, composer, php, php-library, simplexml
- Language: PHP
- Size: 74.2 KB
- Stars: 130
- Watchers: 20
- Forks: 50
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AmazonProductAPI
PHP library to perform product lookup and searches using the Amazon Product API.
## Installation
This library requires the [SimpleXML](http://php.net/manual/en/book.simplexml.php) and [Curl](http://php.net/manual/en/book.curl.php) extensions to be installed and uses PHP 7+ . Installation is simple using [Composer](https://composer.io):
```shell
composer require marcl/amazonproductapi
```
### Amazon Product API
It also assumes that you have some basic knowledge of Amazon's Product API and have set up an Amazon Associate account see: [Amazon Product API Set Up](http://docs.amazonwebservices.com/AWSECommerceService/2011-08-01/GSG/GettingSetUp.html).
You'll need an AWS key, secret key, and associate tag. Ensure that you keep these safe!
## Examples
I've added some simple examples in `examples.php`. To run them create a file called `secretKeys.php` containing your secret keys:
```php
```
and then run the examples with:
```shell
php examples.php
```
## Quick Start
Include the library in your code using the Composer autoloader and create an AmazonUrlBuilder with your credentials
```php
require('vendor/autoload.php');
use MarcL\AmazonAPI;
use MarcL\AmazonUrlBuilder;
// Keep these safe
$keyId = 'YOUR-AWS-KEY';
$secretKey = 'YOUR-AWS-SECRET-KEY';
$associateId = 'YOUR-AMAZON-ASSOCIATE-ID';
// Setup a new instance of the AmazonUrlBuilder with your keys
$urlBuilder = new AmazonUrlBuilder(
$keyId,
$secretKey,
$associateId,
'uk'
);
// Setup a new instance of the AmazonAPI and define the type of response
$amazonAPI = new AmazonAPI($urlBuilder, 'simple');
$items = $amazonAPI->ItemSearch('harry potter', 'Books', 'price');
```
**Note:** Keep your Amazon keys safe. Either use environment variables or include from a file that you don't check into GitHub.
### Locale
This library supports all [Product Advertising API locales](https://affiliate-program.amazon.com/assoc_credentials/home) and you can set it as you construct the AmazonUrlBuilder class with your keys.
At this time, these are the current supported locales:
* Brazil ('br')
* Canada ('ca')
* China ('cn')
* France ('fr')
* Germany ('de')
* India ('in')
* Italy ('it')
* Japan ('jp')
* Mexico ('mx')
* Spain ('es')
* United Kingdom ('uk')
* United States ('us')
### Item Search
To search for an item use the `ItemSearch()` method:
```php
// Search for harry potter items in all categories
$items = $amazonAPI->ItemSearch('harry potter');
// Search for harry potter items in Books category only
$items = $amazonAPI->ItemSearch('harry potter', 'Books');
```
#### Default sort
By default, the `ItemSearch()` method will search by featured. If you want to sort by another category then pass a 3rd parameter with the name of the category you wish to sort by. These differ by category type but the two you'll probably need are `price` (sort by price low to high) or `-price` (sort by price high to low). See [ItemSearch Sort Values](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/APPNDX_SortValuesArticle.html) for more details.
```php
// Search for harry potter items in Books category, sort by low to high
$items = $amazonAPI->ItemSearch('harry potter', 'Books', 'price');
// Search for harry potter items in Books category, sort by high to low
$items = $amazonAPI->ItemSearch('harry potter', 'Books', '-price');
```
To determine valid categories for search call `GetValidSearchNames()`:
```php
// Get an array of valid search categories we can use
$searchCategories = $amazonAPI->GetValidSearchNames();
```
### Item Lookup
To look up product using the product ASIN number use `ItemLookup()`:
```php
// Retrieve specific item by id
$items = $amazonAPI->ItemLookUp('B003U6I396');
// Retrieve a list of items by ids
$asinIds = array('B003U6I396', 'B003U6I397', 'B003U6I398');
$items = $amazonAPI->ItemLookUp($asinIds);
```
### Data Transformation
By default the data will be returned as SimpleXML nodes. However, you can ask for the data to be transformed differently, depending on your use case for the API. Pass a type when instantiating the AmazonAPI class as follows:
```php
// Default return type is XML
$amazonAPI = new AmazonAPI($amazonUrlBuilder);
$items = $amazonAPI->ItemSearch('harry potter');
var_dump($items);
```
This will output:
```shell
class SimpleXMLElement#2 (2) {
public $OperationRequest =>
class SimpleXMLElement#3 (3) {
public $RequestId =>
string(36) "de58449e-0c1a-47ac-9823-00fd049c52df"
public $Arguments =>
class SimpleXMLElement#5 (1) {
public $Argument =>
array(11) {
...
```
```php
// Return simplified data
$amazonAPI = new AmazonAPI($amazonUrlBuilder, 'simple');
$items = $amazonAPI->ItemSearch('harry potter');
var_dump($items);
```
This will return a simplified version of each item with minimal data but enough for simple use cases.
```
array(10) {
[0] =>
array(8) {
'asin' =>
string(10) "B00543R3WG"
'url' =>
string(212) "http://www.amazon.co.uk/Harry-Potter-Complete-8-Film-Collection/dp/B00543R3WG%3FSubscriptionId%3D1BM0B8TXM1YSZ1M0XDR2%26tag%3Ddjcr-21%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3DB00543R3WG"
'rrp' =>
double(44.99)
'title' =>
string(58) "Harry Potter - The Complete 8-Film Collection [DVD] [2011]"
'lowestPrice' =>
double(23.4)
'largeImage' =>
string(53) "http://ecx.images-amazon.com/images/I/51qa9nTUsEL.jpg"
'mediumImage' =>
string(61) "http://ecx.images-amazon.com/images/I/51qa9nTUsEL._SL160_.jpg"
'smallImage' =>
string(60) "http://ecx.images-amazon.com/images/I/51qa9nTUsEL._SL75_.jpg"
}
[1] =>
array(8) {
'asin' =>
string(10) "0747558191"
'url' =>
string(212) "http://www.amazon.co.uk/Harry-Potter-Philosophers-Stone-Rowling/dp/0747558191%3FSubscriptionId%3D1BM0B8TXM1YSZ1M0XDR2%26tag%3Ddjcr-21%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D0747558191"
'rrp' =>
double(6.99)
'title' =>
string(40) "Harry Potter and the Philosopher\'s Stone"
…
```
The different data transformation types are defined as follows. Feel free to raise an issue if you'd like the data transforming to a new type.
* **xml** - (Default) returns data as SimpleXML nodes.
* **array** - Returns data as PHP arrays and objects.
* **simple** - Returns data as simplified arrays and doesn't contain all API data. Use this if you just need prices, title and images.
* **json** - Returns data as a JSON string. Use this for returning from a server API endpoint.
## TODO
* Need to make the simplified data less hardcoded!
## Thanks
This library uses code based on [AWS API authentication For PHP](http://randomdrake.com/2009/07/27/amazon-aws-api-rest-authentication-for-php-5/) by [David Drake](https://github.com/randomdrake) but has been mostly rewritten.
## LICENSE
See [LICENSE](LICENSE)