PHPackages                             rovast/amazon-advertising-api-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rovast/amazon-advertising-api-php-sdk

ActiveLibrary[API Development](/categories/api)

rovast/amazon-advertising-api-php-sdk
=====================================

Amazon Advertising API Client Library

1.2(8y ago)220.7kApache OSL-2PHPPHP >=5.3.0

Since Aug 28Pushed 8y agoCompare

[ Source](https://github.com/rovast/amazon-advertising-api-php-sdk)[ Packagist](https://packagist.org/packages/rovast/amazon-advertising-api-php-sdk)[ Docs](https://advertising.amazon.com/)[ RSS](/packages/rovast-amazon-advertising-api-php-sdk/feed)WikiDiscussions mine Synced 3w ago

READMEChangelog (1)DependenciesVersions (4)Used By (0)

About
=====

[](#about)

This is a fork from amazon official SDK. [amzn/amazon-advertising-api-php-sdk](https://github.com/amzn/amazon-advertising-api-php-sdk)

**updated points**

- support composer install

> The official sdk does not support composer, now you can run `composer require rovast/amazon-advertising-api-php-sdk` to install.

- add timeout option for curl request

> By default, the official SDK has no timeout option for curl request. If there is something wrong with Network, the download report job may handle all the time.

- add gzdecode option for get\_report

> When you download report, you may want xx.gz binary content instead of json content. Cause the binary is compressed and has a small file size.

**branch**

- master

> This branch is the same to official SDK

- mine

> This branch is updated, and add some points.

**composer install the official sdk**

`composer require rovast/amazon-advertising-api-php-sdk`

**composer install mine sdk**

`composer require rovast/amazon-advertising-api-php-sdk:dev-mine`

---

Synopsis
--------

[](#synopsis)

Official Amazon Advertising API PHP client library.

Requirements
------------

[](#requirements)

PHP >= 5.3.0
cURL >= 7.18

Documentation
-------------

[](#documentation)

[API Reference](https://images-na.ssl-images-amazon.com/images/G/01/AdProductsWebsite/downloads/Amazon_Advertising_API_Reference.pdf)
[Access Request](https://advertising.amazon.com/API)
[Getting Started](https://images-na.ssl-images-amazon.com/images/G/01/AdProductsWebsite/downloads/Amazon_Advertising_API_Getting_Started_Guide.pdf)

Tutorials
---------

[](#tutorials)

[Register Sandbox Profile](https://git.io/vPKMl) - This tutorial will show you how to register a profile in sandbox using CURL.
[Generate and download a report using CURL](https://git.io/vPKPW) - You will need to complete registering a profile in sandbox prior to doing this tutorial.

Sandbox self-service
--------------------

[](#sandbox-self-service)

If you would like to test the API in sandbox you will need to register a profile for the region in which you would like to test. The `registerProfile` API call can be made to do this. Make sure you instantiate the client in `sandbox` mode before making this call or it will fail.

The following country codes are available for testing.

> US, CA, UK, DE, FR, ES, IT, IN, CN, JP

```
$client->registerProfile(array("countryCode" => "IT"));
```

>

```
{
  "registerProfileId": "5cf1aca5-4ab8-4489-8c33-013d1f85c586JP",
  "status": "IN_PROGRESS",
  "statusDetails": "Registration workflow has been started"
}

```

Quick Start
-----------

[](#quick-start)

#### Instantiate the client

[](#instantiate-the-client)

> You can pass in `accessToken` if you do not have a refresh token.

```