Software

Hop AWS Products (Amazon Web Services)

Current Version: 5.1.0
  • EE3
  • EE4
  • EE5
  • Installation

    1. Unzip the folder to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s folder on the server.

  • Usage

    Implement using the tag pair:

    {exp:hop_aws_products:search}

    You’ll get output that you can use to create links like the ones to these items….

  • Examples

    {exp:hop_aws_products:search
        partner_tag="truthdig20-20"
        item_id="0470230177"
        public_key="xxxxxxxxxx"
        private_key="xxxxxxxxxxxxxxxxxxxxxxxx"
        display_all_var="yes"
    }
        <h1>{ItemInfo_Title_DisplayValue} ({ASIN})</h1> 
        <h3>Contributors/Authors: <br/><small>{ItemInfo_ByLineInfo_Contributors}{Name}<br/>{/ItemInfo_ByLineInfo_Contributors} </small></h3>
    
        {Offers_Summaries}
            <p>{Condition_Value}: {LowestPrice_DisplayAmount} {LowestPrice_Currency}</p>
        {/Offers_Summaries}
    
        <h2>Primary Image:</h2>
        <img src="{Images_Primary_Large_URL}">
    
        <h2>Variant Images:</h2>
        {Images_Variants}
            <img src="{Large_URL}"><br/>
            {Large_URL}
        {/Images_Variants}
    
    {/exp:hop_aws_products:search}
  • Parameters

    • `public_key=”xxxxxx”` REQUIRED
    • `private_key=”xxxxxxxxxxxxxx”` REQUIRED
    • `item_id=”B000K21D4K”` REQUIRED. Amazon ASIN.
    • `region=”com”` DEFAULT=”COM” Amazon domain suffix. Non-US users may wish to change this. You also need to set it accordingly to your AWS account region. For instance, a UK account won’t work with the com region.
    • `associate_id=”hopstudios”` configures an associate ID for Amazon’s affiliate program (default: “hopstudios”).
    • `index=”Books”` DEFAULT=”BOOKS” configures the search index.
    • `limit=”5”` DEFAULT=”5” Limit of results returned in multi-value result sets (maximum 10).
    • `page=”1”` retrieve specific results page (Amazon limits that to 10, even if there’s more pages).
    • `debug=”yes”` DEFAULT=”NO” Shows additional output in template debugging.
    • `display_all_var=”yes”` DEFAULT=NO” List all the available tags for each item.
    • `delay=”2”` delay the query by 2 seconds. Handy if doing multiple queries in one page (AWS can throttle the requests)
  • Tags

    Tags are subject to change, based on the Amazon API.

    For a full list of available tags please use the display_all_var="yes" parameter when setting up.

    • {ASIN}
    • {DetailPageURL}
    • {ItemInfo_Title_DisplayValue}
    • {Images_Primary_Large_URL}
    • {Images_Primary_Medium_URL}
    • {Images_Primary_Small_URL}
  • Tag Pairs

    • `{define_keywords}search for this, and this{/define_keywords}`
    • If you do not include an ITEM_ID parameter, then this is REQUIRED. It doesn’t matter where you place this variable pair, but it MUST be defined inside the tags. If you are going to use a custom field for your keywords, also be sure that it has formatting set to NONE in your publish preferences.
    • `{ItemInfo_ByLineInfo_Contributors} … {/ItemInfo_ByLineInfo_Contributors}`
    • Loop through all item authors/contributors. This loop provides the following tags: `{Name}`, `{Role}`, `{RoleType}`
    • `{Images_Variants} … {/Images_Variants}`
    • Loop through all available variant images from Amazon. Not that this does not include the primary item image obtained with `{Images_Primary_Large_URL}` “` {Images_Primary_Large_URL} {Large_Height} 500 {Large_URL} https://m.media-amazon.com/images/I/61xI2xsLW9L.jpg {Large_Width} 403 {Medium_Height} 160 {Medium_URL} https://m.media-amazon.com/images/I/61xI2xsLW9L._SL160_.jpg {Medium_Width} 129 {Small_Height} 75 {Small_URL} https://m.media-amazon.com/images/I/61xI2xsLW9L._SL75_.jpg {Small_Width} 60 {/Images_Primary_Large_URL} “`
  • EE2 Code Examples

    The EE2 version uses slightly different tags. Here’s a basic set of examples.

    These will NOT work for the current EE3 version.

    Example 1

    {exp:aws_products:search limit="20" region="com" debug="no" associate_id="hopstudios" public_key="use_your_own" private_key="use_your_own"}
    {define_keywords}blogging for dummies gardner{/define_keywords}
     {if aws_total_results > 0}total results: {aws_total_results}<br />{/if}
     {if aws_count > 0}count: {aws_count}<br />{/if}
     {if amz_asin}amz_asin: {amz_asin}<br />{/if}
     {if amazon_link}amazon_link: <a href="{amazon_link}">{amazon_link}</a><br />{/if}
     {if product_name}product_name: {product_name}<br />{/if}
     {if release_date}release_date: {release_date}<br />{/if}
     {if catalog_type}catalog_type: {catalog_type}<br />{/if}
     {if manufacturer}manufacturer: {manufacturer}<br />{/if}
     {if publisher}publisher: {publisher}<br />{/if}
     {if sales_rank}sales_rank: {sales_rank}<br />{/if}
     {if number_of_pages}number_of_pages: {number_of_pages}<br />{/if}
     {if best_price}best_price: {best_price}<br />{/if}
     {if list_price}list_price: {list_price}<br />{/if}
     {if amz_authors}amz_authors: {amz_authors}<br />{/if}
     {if img_small}img_small: <img src="{img_small}" /><br />{/if}
     {if img_medium}img_medium: <img src="{img_medium}" /><br />{/if}
     {if img_large}img_large: <img src="{img_large}" /><br />{/if}
     {if img_small_width}img_small_width: {img_small_width}<br />{/if}
     {if img_medium_width}img_medium_width: {img_medium_width}<br />{/if}
     {if img_large_width}img_large_width: {img_large_width}<br />{/if}
     {if img_small_height}img_small_height: {img_small_height}<br />{/if}
     {if img_medium_height}img_medium_height: {img_medium_height}<br />{/if}
     {if img_large_height}img_large_height: {img_large_height}<br />{/if}
    {/exp:aws_products:search}

    Example 2

    {exp:aws_products:search item_id="0470230177" associate_id="hopstudios" public_key="use_your_own" private_key="use_your_own"}
    Great news! {product_name} only costs ${best_price} today.
    {/exp:aws_products:search}

    Parameters

    • associate_id=”hopstudios” configures an associate ID for Amazon’s affiliate program (default: “hopstudios”).
    • region=”com” sets the domain suffix, i.e. which Amazon store (default: “com”). Non-US users may wish to change this.
    • index=”Books” configures the search index (default: “Books”).
    • limit=”5” sets the limit of results returned in multi-value result sets (default: “5”).
    • debug=”yes” puts some additional output in template debugging (default: “no”).

    REQUIRED

    • public_key = your “Access Key ID”
    • private_key = your “Secret Access Key”

    REQUIRED UNLESS USING KEYWORDS TAG PAIR

    • item_id=”B000K21D4K” is an Amazon ASIN.

    Tag Pairs

    {define_keywords}search for this, and this{/define_keywords}

    allows you to search for keywords. This is required, unless you use the item_id parameter. It doesn’t matter where you place this variable pair, but it must be defined inside the tags. If you are going to use a custom field for your keywords, also be sure that it has formatting set to NONE in your publish preferences.

    If you’re displaying an image, it’s good practice to check that its width or height are greater than 1, since Amazon may return a blank 1x1 image if none exists.

    {if img_small_width > 5}<img src="{img_small}" alt="{product_name}" />{/if}
  • Updating

    Updating is easy:

    1. Download a new version from this website, and extract on your hard drive.
    2. Upload the new files to their appropriate locations.

  • Uninstalling

    1. Navigate to the Add-Ons/Modules tab in your EE control panel and uninstall the module.
    2. Remove the add-on directory from your EE system folder on the server.

  • Version History

    Last updated: about 7 months ago

    5.1.0 - 2020-06-23

    • Short if conditions
    • Documentation updates

    5.0.0 - 2020-04-22

    • Uses the new API

    4.1.1 - 2017-12-11

    • Add a delay parameter

    4.1.0 - 2016-11-02

    • Add a fix for items having multiple authors
    • Add feature to display all available tags
    • Add a page parameter
    • Updated for EE 3

    4.0.0 - 2016-08-18

    • Major changes to tag names to more closely adhere to Amazon’s attribute names
    • Many more attributes available to use &mdash all that Amazon provides, in fact, and it updates as Amazon does.

    3.1.1 - 2015-04-28

    • 2015/04/28
    • Fix encoding issue
    • Fix bug when a template tag doesn’t exist

    3.1.0 - 2011-04-23

    • 2011/04/23 (Travis Smith, Hop Studios):
    • Added error message for missing keys
    • Added .at and .es and .it stores
    • Changed the AWS server it talks to
    • Fixed a bug in “define_keywords”

    3.0.0 - 2011-04-24

    • 4/24/2011
    • First version for EE 2.x
    • Added several more fields
    • Fixed an error when multiple authors were available for a book
    • Includes version 2.0.0 for EE 1.x

    2.0.0 - 2010-01-29

    • 1/29/2010 (Justin Crawford, Hop Studios):
    • Added aws_signed_request function to accommodate the new signed URL requirements on AWS
    • Made major changes to code formatting
    • Made minor changes to logic/data structures
    • Edited comments for brevity/clarity
    • Changed parameters/variable names for consistency with current EE convention
    • Added an item_id parameter for single-item lookups
    • Added a public_key and private_key parameter for signed URLs
    • Revised conditional handling

    1.0.0 - 2004-10-15

    • First Version based on Lynda’s Amazon Api Plugin (Christian Leu, http://leumund.ch/)

Have a Project for Us?

Get in Touch