1. module amazon-product-api
   1. function amazon-product-api.createClient (credentials)
   2. object amazon-product-api.utils
2. module amazon-product-api.utils
   1. function amazon-product-api.utils.formatQueryParams (query, method, credentials)
   2. function amazon-product-api.utils.generateQueryString (query, method, credentials)

module amazon-product-api

function amazon-product-api.createClient (credentials)

• description and source-code

  createClient = function (credentials) {
    return {
      itemSearch: runQuery(credentials, 'ItemSearch'),
      itemLookup: runQuery(credentials, 'ItemLookup'),
      browseNodeLookup: runQuery(credentials, 'BrowseNodeLookup')
    };
  }

• example usage

  ...
  Require library
  ```javascript
  var amazon = require('amazon-product-api');
  ```
  
  Create client
  ```javascript
  var client = amazon.createClient({
    awsId: "aws ID",
    awsSecret: "aws Secret",
    awsTag: "aws Tag"
  });
  ```
  Now you are ready to use the API!
  ...

module amazon-product-api.utils

function amazon-product-api.utils.formatQueryParams (query, method, credentials)

• description and source-code

  formatQueryParams = function (query, method, credentials) {
    var params = {};
  
    // format query keys
    for (var param in query) {
      var capitalized = capitalize(param);
      params[capitalized] = query[param];
    }
  
    if (method === 'ItemSearch') {
      // Default
      params = setDefaultParams(params, {
        SearchIndex: 'All',
        Condition: 'All',
        ResponseGroup: 'ItemAttributes',
        Keywords: '',
        ItemPage: '1'
      });
  
    } else if (method === 'ItemLookup') {
      // Default
      params = setDefaultParams(params, {
        SearchIndex: 'All',
        Condition: 'All',
        ResponseGroup: 'ItemAttributes',
        IdType: 'ASIN',
        IncludeReviewsSummary: 'True',
        TruncateReviewsAt: '1000',
        VariationPage: 'All'
      });
  
      // Constraints
      // If ItemId is an ASIN (specified by IdType), a search index cannot be specified in the request.
      if (params['IdType'] === 'ASIN') {
        delete params['SearchIndex'];
      }
  
    } else if (method === 'BrowseNodeLookup') {
      // Default
      params = setDefaultParams(params, {
        BrowseNodeId: '',
        ResponseGroup: 'BrowseNodeInfo'
      });
    }
  
  
    // Constants
    params['Version'] = '2013-08-01';
  
    // Common params
    params['AWSAccessKeyId'] = credentials.awsId;
    // awsTag is associated with domain, so it ought to be defineable in query.
    params['AssociateTag'] = query.awsTag || credentials.awsTag;
    params['Timestamp'] = new Date().toISOString();
    params['Service'] = 'AWSECommerceService';
    params['Operation'] = method;
  
    // sort
    params = sort(params);
  
    return params;
  }

• example usage

  n/a

function amazon-product-api.utils.generateQueryString (query, method, credentials)

• description and source-code

  generateQueryString = function (query, method, credentials) {
    var unsignedString = '';
    var domain = query.domain || 'webservices.amazon.com';
    var params = formatQueryParams(query, method, credentials);
  
    // generate query
    unsignedString = Object.keys(params).map(function (key) {
      return key + "=" + encodeURIComponent(params[key]).replace(/[!'()*]/g, function(c) {
        return '%' + c.charCodeAt(0).toString(16);
      });
    }).join("&")
  
    var signature = encodeURIComponent(generateSignature('GET\n' + domain + '\n/onca/xml\n' + unsignedString, credentials.awsSecret
  )).replace(/\+/g, '%2B');
    var queryString = 'https://' + domain + '/onca/xml?' + unsignedString + '&Signature=' + signature;
  
    return queryString;
  }

• example usage

  n/a