Product Advertising API
Getting Started Guide (API Version 2013-08-01)
Did this page help you?  Yes | No |  Tell us about it...
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.

Getting Set Up with Product Advertising API

This section provides step-by-step instructions that you must complete before you can submit your first Product Advertising API request.


Step 1: Become an Associate

Associates earn commissions by using their own website to refer sales to www.amazon.com. To get a commission, an Associate must have an Associate ID. This ID works only in the locale in which you register. If you want to be an Associate in more than one locale, you must register separately for each locale.

The following table lists the websites to use for more information about becoming an Associate.

Getting Your Associate Tag

After you register as an Amazon Associate, you'll receive an Associate tag, also known as an Associate ID, in email. The Associate tag is an automatically generated unique identifier that you will use to make requests through the Product Advertising API. When you log in to the Amazon Associates website for your locale, you are directed to a page that says "Signed in as" followed by your Associate tag.

Step 2: Get Your Security Credentials

You need security credentials to call the Product Advertising API, authenticate requests, and identify yourself as the sender of a request. Two types of credentials are available:

  • AWS security credentials (access key ID and secret access key)

  • X.509 certificates

Note

IAM roles are not currently supported. You must use the root account credentials or certificates.

To generate and manage your credentials, go to the AWS Security Credentials Console.

Step 3: Get the Tools You Need

Programming Language Tools

Product Advertising API requests can be integrated into applications using most modern programming languages. In the following table, click the tool you want to use to implement Product Advertising API. The link takes you to the corresponding website where you can download and install the appropriate toolkit.

LanguageAPI StyleTools Used

Java

SOAP

  • Java 6 or higher

    Make sure the PATH environment variable points at the Java installation.

  • Eclipse 3.2 or higher

    If you use Eclipse as your interactive development environment (IDE), you must use version 3.2 or higher. You can, however, use other IDEs, such as NetBeans.

C#

SOAP

Perl

REST (using HTTP POST)

To download the modules used in the following Perl example, go to CPAN website:

  • Digest::HMAC_SHA1

  • MIME::Base64

  • LWP

  • XML::XPath

  • Date::Format

PHP

REST (using HTTP GET)

The PHP example uses the base installation of PHP5.

Because PHP configurations vary, we're using a command-line interface to run our example. You can also run the example through a web server, but those details are not covered in this guide.

Product Advertising API Signed Requests Helper

All requests you send to Product Advertising API must be authenticated using a signed version of the request. Use the Product Advertising API Signed Requests Helper to generate this signed request. You can use this tool online or download it to your machine.

Step 4: Set Up Your Development Environment

This section helps you confirm that your development environment is set up correctly. Skip to the section that corresponds to the toolkit you downloaded. Or, if you are viewing this document online, you can view the setup steps for your preferred programming language by using the Filter View list on the top-right corner of the page.

Java Setup

You can implement Product Advertising API operations directly in Java. You can also generate and use the Product Advertising API Java Client-Side library to simplify your Java implementations. This section explains how to generate the Product Advertising API Java Client-Side Library. The next section shows you how to use it to create a request.

Generating the Stubs

You use the wsimport utility in Java 6 to generate the stubs from the Product Advertising API WSDL, which is located at http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl.

To generate the Product Advertising API client-side library stubs

  1. Go to the directory where you want to generate the stubs and create a "build" directory and a "src" directory.

    All of the generated source code goes under "src" folder.

  2. If you are using Eclipse 3.2, create a custom binding to disable "Wrapper Style" code generation.

    <jaxws:bindings wsdlLocation="http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl" xmlns:jaxws="http://java.sun.com/xml/ns/jaxws">
      <jaxws:enableWrapperStyle>false</jaxws:enableWrapperStyle>
    </jaxws:bindings>

    This step is required because Eclipse 3.2 does not support wrapper-style generated code. If you're using an IDE that supports wrapper-style generated code, such as NetBeans, this step is not required.

  3. Run the command:

    wsimport -d ./build -s ./src  -p com.ECS.client.jax http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl -b jaxws-custom.xml . 

    You can find the generated stubs in the path, com.ECS.client.jax.

Generated File Types

Several file types are generated in the package, com.ECS.client.jax:

  • AWSECommerceService—This file identifies the Product Advertising API service.

  • AWSECommerceServicePortType—This file provides the port type that the client can listen on.

    This file also contains a list of all Product Advertising API operation signatures that can be used to build the client.

C# Setup

Product Advertising API requires that you have successfully installed Microsoft Visual Studio.

To confirm the installation

  1. Open Microsoft Visual 2005 C# Express Edition.

  2. Click Help > About Microsoft Visual Studio.

    The dialog box that opens should list Microsoft Visual Studio 2005 and version 2.0 of the .NET Framework.

Create the SOAP Proxy in Visual Studio

In your application, you must add a web reference to the Product Advertising API WSDL you want to use.

To add a web reference

  1. On the Project menu, click Add Web Reference.

  2. In the URL box, type http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl, and then click Go.

  3. Click Add Reference.

A new Web References folder is added to the Solution Explorer.

You can now reference the SOAP proxy using your project namespaces. For example:

using GettingStartedGuideSample.com.amazonaws.ecs;

Perl Setup

Run the following commands to verify that you have installed all of the required Perl modules:

perl -MDigest::HMAC_SHA1 -e 1
perl -MMIME::Base64 -e 1
perl -MLWP -e 1
perl -MXML::XPath -e 1
perl -MDate::Format -e 1

You should not receive any error messages.

PHP Setup

To verify your PHP installation

  • Use a command-line interface to run the following command:

    php -version

    This command assumes you are either in your PHP installation directory or it is in your PATH system variable.

The response should be similar to the following:

PHP 5.1.2 (cli) (built: Jan 11 2006 16:40:00)
Copyright (c) 1997-2006 The PHP Group
Zend Engine v2.1.0, Copyright (c) 1998-2006 Zend Technologies