Repository files navigation

apac (Amazon Product Advertising Client) will allow you to access the Amazon Product Advertising API from Node.js.Learn more about the Amazon Product Advertising API.

node-apac is just a thin wrapper around Amazon's API. The only intent is to take care of request signatures, performingthe HTTP requests, processing the responses and parsing the XML. You should be able to run any operation because theoperation and all parameters are passed directly to the execute method just as they will be passed to Amazon. The resultis that you feel like you're working directly with the API, but you don't have to worry about some of the more tedioustasks.

Install using npm:

$ npm install apac

Here's a quick example:

const{OperationHelper}=require('apac');constopHelper=newOperationHelper({awsId:'[YOUR AWS ID HERE]',awsSecret:'[YOUR AWS SECRET HERE]',assocId:'[YOUR ASSOCIATE TAG HERE]'});opHelper.execute('ItemSearch',{'SearchIndex':'Books','Keywords':'harry potter','ResponseGroup':'ItemAttributes,Offers'}).then((response)=>{console.log("Results object: ",response.result);console.log("Raw response body: ",response.responseBody);}).catch((err)=>{console.error("Something went wrong! ",err);});

Example Response:

{ItemSearchResponse:{OperationRequest:[Object],Items:[Object]}}

Since we just wrap the Amazon Product Advertising API, you'll reference their API docs:API Reference

Sign up here:https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html

This will also direct you where to get your security credentials (accessKeyId and secretAccessKey)

You will also need to go here:http://docs.aws.amazon.com/AWSECommerceService/latest/DG/becomingAssociate.htmland click on one of the locale specific associate websites to sign up as an associate and get an associate ID,which is required for all API calls.

By default, Amazon limits you to one request per second per IP. This limit increases with revenue performance. Learnmore here:http://docs.aws.amazon.com/AWSECommerceService/latest/DG/TroubleshootingApplications.html

To help you ensure you don't exceed the request limit, we provide an automatic throttling feature. By default, apac willnot throttle. To enable throttling, set the maxRequestsPerSecond param when constructing your OperationHelper.

varopHelper=newOperationHelper({awsId:'[YOUR AWS ID HERE]',awsSecret:'[YOUR AWS SECRET HERE]',assocId:'[YOUR ASSOCIATE TAG HERE]',maxRequestsPerSecond:1});

To use a locale other than the default (US), set the locale parameter.

varopHelper=newOperationHelper({awsId:'[YOUR AWS ID HERE]',awsSecret:'[YOUR AWS SECRET HERE]',assocId:'[YOUR ASSOCIATE TAG HERE]',locale:'IT'});

Supported Locales

Feel free to submit a pull request. If you'd like, you may discuss the change with me first by submitting an issue.Please test all your changes. Current tests are located in lib/*.specs.js (next to each file under test).

Execute tests withnpm test

Execute acceptance tests withnpm run test:acceptance.For acceptance tests, you must set these environment variables first:

AWS_ACCESS_KEY_ID=[VALUE]AWS_SECRET_ACCESS_KEY=[VALUE]AWS_ASSOCIATE_ID=[VALUE]

You can set these values in your environment or intest/acceptance/.env.

Copyright (c) 2016 Dustin McQuay. All rights reserved.

Permission is hereby granted, free of charge, to any personobtaining a copy of this software and associated documentationfiles (the "Software"), to deal in the Software withoutrestriction, including without limitation the rights to use,copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom theSoftware is furnished to do so, subject to the followingconditions:

The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIESOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHTHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISINGFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OROTHER DEALINGS IN THE SOFTWARE.