https://github.com/double-break/spapi-php
Amazon Selling Partner API PHP Client
https://github.com/double-break/spapi-php
Last synced: 6 months ago
JSON representation
Amazon Selling Partner API PHP Client
- Host: GitHub
- URL: https://github.com/double-break/spapi-php
- Owner: double-break
- License: mit
- Created: 2020-12-22T16:02:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-30T11:26:56.000Z (over 3 years ago)
- Last Synced: 2025-04-11T12:51:59.706Z (7 months ago)
- Language: PHP
- Size: 98.6 KB
- Stars: 56
- Watchers: 6
- Forks: 48
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-spapi - double-break/spapi-php - break/spapi-php?style=plastic&logoWidth=1) (Docs / Library)
README
# SPAPI
spapi-php is a http client for Amazon's Selling Partner API
Author: Lyubomir Slavilov
## Before you start
Spapi is released as Composer package `double-break/spapi-php` with **no warranties or promises**.
There are couple classes (such as `Signer`, `Credentials`) which are essential for the API calls to work. Most of the issues will live here.
All of the actual API clients are autogenerated and given the disclaimer above - not heavily tested.
### Requirements
- php 7.3 (never tested on lower version)
- composer
- a lot of time reading Amazon SP API documentation
## Install and update
Now you are ready to do
```bash
composer require double-break/spapi-php
```
### Package updates
Once you have successfully installed the package, the updates are simple as normal Composer package updates. Just execute:
```bash
composer update double-break/spapi-php
```
## Configuration
| Name | Description | Type |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| `http` | Contains all the `Guzzle` configuration | GuzzleConfiguration |
| **LWA configuration** | |
| `refresh_token` | Value of the refresh token issued by the Seller authorizing the application | string |
| `client_id` | The client id which is generated in the Seller Apps console | string |
| `client_secret` | The client secret with which the client will identify itself | string |
| `access_token_longevity` | The longevity in seconds of the token. It is basically the time period in which the token will be kept in the `TokenStorage` | integer
Default: 3600 |
| **STS configuration** | |
| `access_key` | The IAM role access key | string |
| `secret_key` | The IAM role secret key | string |
| `role_arn` | The ARN of the IAM role | string |
| `sts_session _longevity` | The longevity of the STS session which will be created | integer
Default: 3600 |
| **API configuration** | |
| `region` | The region identifier for the region you are going to execute your calls against | string
Example: `eu-west-1` |
| `host` | The region specific host of the Selling Partner API | string
Example: `sellingpartnerapi-eu.amazon.com` |
## Examples
### Simple use
```php
[
'verify' => false, //<--- NOT SAFE FOR PRODUCTION
'debug' => true //<--- NOT SAFE FOR PRODUCTION
],
//LWA: Keys needed to obtain access token from Login With Amazon Service
'refresh_token' => '',
'client_id' => '',
'client_secret' => '',
//STS: Keys of the IAM role which are needed to generate Secure Session
// (a.k.a Secure token) for accessing and assuming the IAM role
'access_key' => '',
'secret_key' => '',
'role_arn' => '' ,
//API: Actual configuration related to the SP API :)
'region' => 'eu-west-1',
'host' => 'sellingpartnerapi-eu.amazon.com'
];
//Create token storage which will store the temporary tokens
$tokenStorage = new DoubleBreak\Spapi\SimpleTokenStorage('./aws-tokens');
//Create the request signer which will be automatically used to sign all of the
//requests to the API
$signer = new DoubleBreak\Spapi\Signer();
//Create Credentials service and call getCredentials() to obtain
//all the tokens needed under the hood
$credentials = new DoubleBreak\Spapi\Credentials($tokenStorage, $signer, $config);
$cred = $credentials->getCredentials();
/** The application logic implementation **/
//Create SP API Catalog client and execute one ot its REST methods.
$catalogClient = new DoubleBreak\Spapi\Api\CatalogItems($cred, $config);
//Check the catalog info for B074Z9QH5F ASIN
$result = $catalogClient->getCatalogItem('B074Z9QH5F', [
'marketplaceIds' => 'A1PA6795UKMFR9',
]);
print_r($result);
```
### Feed API usage
For Feed API, user can follow [Feeds API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/use-case-guides/feeds-api-use-case-guide-2020-09-04.md).
And in this guide for step 2. Encrypt and upload the feed data: user can use below example:
```php
createFeedDocument(["contentType" => $contentType]);
$payload = $response['payload'];
$feedContentFilePath = './testFeedDoc.xml';
$result = (new \DoubleBreak\Spapi\Helper\Feeder())->uploadFeedDocument($payload,$contentType,$feedContentFilePath);
print_r($result);
```
And for Step 6. Download and decrypt the feed processing report: user can use below example:
```php
getFeedDocument($resultFeedDocumentId);
$payload = $response['payload'];
$result = (new \DoubleBreak\Spapi\Helper\Feeder())->downloadFeedProcessingReport($payload);
print_r($result);
```
### Debugging responses
```php
getCatalogItem('B074Z9QH5F', [
'MarketplaceId' => 'A1PA6795UKMFR9',
])['payload'];
//do your business here
} catch (\GuzzleHttp\Exception\ClientException $e) {
$httpCode = $e->getResponse()->getStatusCode();
$errorBody = $e->getResponse()->getBody();
echo "Amazon SP API responded with HTTP {$httpCode}\n {$errorBody}";
} catch(\Exception $e) {
echo "Unexpected exception: " . $e->getMessage();
}
```
### Accessing response headers
đź“ťAccessing headers by using client's `getLastHttpResponse()` is available since v1.0.5
```php
getCatalogItem('B074Z9QH5F', [
'MarketplaceId' => 'A1PA6795UKMFR9',
])['payload'];
$headers = $catalogClinet->getLastHttpResponse()->getHeaders();
foreach ($headers as $headerName => $values) {
echo "{$headerName}: " . implode(','. $values);
}
```
### Debugging 4xx and 5xx response headers
đź“ťAccessing headers by using client's `getLastHttpResponse()` is available since v1.0.5
```php
getCatalogItem('B074Z9QH5F', [
'MarketplaceId' => 'A1PA6795UKMFR9',
])['payload'];
//do your business here
} catch (\GuzzleHttp\Exception\ClientException $e) {
$headers = $e->getResponse()->getHeaders();
print_r($headers);
}
// OR
try {
$result = $catalogClinet->getCatalogItem('B074Z9QH5F', [
'MarketplaceId' => 'A1PA6795UKMFR9',
])['payload'];
//do your business here
} catch (\GuzzleHttp\Exception\ClientException $e) {
$headers = $catalogClinet->getLastHttpResponse()->getHeaders();
print_r($headers);
}
```
### Migrating authorization from Amazon Marketplace Web Service to Selling Partner Api
[Please, see more details in Selling Partner Api docs](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/developer-guide/SellingPartnerApiDeveloperGuide.md#migrating-authorization-from-amazon-marketplace-web-service)
```php
[
'verify' => false,
'debug' => true
],
//LWA: Keys needed to obtain access token from Login With Amazon Service
'refresh_token' => '',
'client_id' => '',
'client_secret' => '',
//STS: Keys of the IAM role which are needed to generate Secure Session
// (a.k.a Secure token) for accessing and assuming the IAM role
'access_key' => '',
'secret_key' => '',
'role_arn' => '' ,
//API: Actual configuration related to the SP API :)
'region' => 'eu-west-1',
'host' => 'sellingpartnerapi-eu.amazon.com'
];
//Create token storage which will store the temporary tokens
$tokenStorage = new DoubleBreak\Spapi\SimpleTokenStorage('./aws-tokens');
//Create the request signer which will be automatically used to sign all of the
//requests to the API
$signer = new DoubleBreak\Spapi\Signer();
//Create Credentials service and call getCredentials() to obtain
//all the tokens needed under the hood
$credentials = new DoubleBreak\Spapi\Credentials($tokenStorage, $signer, $config);
//get credentials with migration token, it's needed for /authorization/v1/authorizationCode request
$cred = $credentials->getCredentials(true);
/** The application logic implementation **/
//Create SP API Catalog client and execute one ot its REST methods.
$authorizationClient = new DoubleBreak\Spapi\Api\Authorization($cred, $config);
//Get Authorization code
$result = $authorizationClient->getAuthorizationCode([
'developerId' => '',
'mwsAuthToken' => '',
'sellingPartnerId' => ''
])['payload'];
//Authorization code should be changed to Access and Refresh token
print_r($credentials->exchangesAuthorizationCodeForRefreshToken($result['authorizationCode']));
```
### Authorization for Grantless Operations in Selling Partner API
[Please, see more details in Selling Partner Api docs](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/developer-guide/SellingPartnerApiDeveloperGuide.md#grantless-operations-1)
```php
[
'verify' => false,
'debug' => true
],
//LWA: Keys needed to obtain access token from Login With Amazon Service
'refresh_token' => '',
'client_id' => '',
'client_secret' => '',
//STS: Keys of the IAM role which are needed to generate Secure Session
// (a.k.a Secure token) for accessing and assuming the IAM role
'access_key' => '',
'secret_key' => '',
'role_arn' => '' ,
//API: Actual configuration related to the SP API :)
'region' => 'eu-west-1',
'host' => 'sellingpartnerapi-eu.amazon.com'
];
//Create token storage which will store the temporary tokens
$tokenStorage = new DoubleBreak\Spapi\SimpleTokenStorage('./aws-tokens');
//Create the request signer which will be automatically used to sign all of the
//requests to the API
$signer = new DoubleBreak\Spapi\Signer();
//Create Credentials service and call getCredentials() to obtain
//all the tokens needed under the hood
$credentials = new DoubleBreak\Spapi\Credentials($tokenStorage, $signer, $config);
//get credentials with Grantless auth token, it's needed for grantless operations request
$cred = $credentials->getCredentials('grantless');
/** The application logic implementation **/
//Create SP API Notification client and execute one ot its REST methods.
$notificationClient = new DoubleBreak\Spapi\Api\Notifications($cred, $config);
//Get notification destinations
$result = $notificationClient->getDestinations();
print_r($result['payload']);
```
### Working with Restricted Data APIs
```php
getRdtCredentials([
'restrictedResources' => [
[
'method' => 'GET',
'path' => '/orders/v0/orders/{orderId}/buyerInfo'
],
[
'method' => 'GET',
'path' => '/mfn/v0/shipments/{shipmentId}'
]
]
]);
/** The application logic implementation **/
//Create SP API Orders client and execute one ot its REST methods.
$orderClient = new DoubleBreak\Spapi\Api\Orders($cred, $config);
//Get order's buyer info
$result = $catalogClient->getOrderBuyerInfo('902-3159896-1390916')['payload'];
print_r($result);
//...
```
For more information see the Amazons's use case documentation about this topic: https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md