Documentation

5.1.2 Overview

The Content - Amazon Product Advertising API plugin lets you embed Amazon product placements into your Joomla 5 site—articles, modules, or any area that processes content tags. Built natively for Joomla 5, this free plugin from RicheyWeb fetches product details using Amazon’s Product Advertising API and displays them with customizable layouts. Add your affiliate tag, and turn clicks into commissions.

Installation

1. Download: Grab the latest version from RicheyWeb.com
2. Install: In your Joomla admin panel, go to System > Manage > Extensions > Install, then upload the plugin ZIP file.
3. Enable: Navigate to System > Manage > Plugins, search for Content - Amazon Product Advertising API, and click the toggle to enable it.

Configuration

Once installed, configure the plugin under System > Manage > Plugins. Find Content - Amazon Product Advertising API and click to open its settings. Options are grouped into three tabs: General, Styling, and Credentials.

General Settings

• Host/Region: Select the Amazon region for API requests (e.g., United States, United Kingdom, Japan).
  • Default: United States.
• Caching: Enable or disable caching of API responses.
  • Default: Enabled (recommended for performance).
• Cache Time: Set how long (in minutes) to cache responses.
  • Default: 1440 (24 hours). Use 0 to inherit Joomla’s global cache time.
• Testing: Enable to restrict the plugin to articles with "paapi" as a keyword.
  • Default: Disabled.

Styling Settings

• Template: Choose the default layout for product displays:
  • Default (Vertical): Stacks product details vertically.
  • Horizontal: Arranges details in a row.
  • Overlay: Shows details overlayed on the main product image.
• Overlay Contrast: For Overlay template only. Pick Light (for dark backgrounds) or Dark (for light backgrounds). Default: Light.
• Button Size: Set the button size: Default, Large, or Small.
• Button Style: Select a button design:
  • Solid: Primary, Secondary, Success, Danger, Warning, Info, Light, Dark, Link.
  • Outline: Primary, Secondary, Success, Danger, Warning, Info, Light, Dark. Default: Dark (Solid).

Credentials

• Access Key: Enter your Amazon Product Advertising API Access Key.
• Secret Key: Enter your Amazon Product Advertising API Secret Key.
• Associate Tag: Enter your Amazon Associate Tag for affiliate earnings.
• Help Links: Below these fields, find links to sign up for an Amazon Affiliate account and review API requirements.

Note

You must have an Amazon Affiliate account and meet Product Advertising API requirements for the plugin to function. See the provided links for details.

Usage

To display an Amazon product, use the plugin’s content tag syntax in any area that processes Joomla content (articles, modules, etc.):

• asin=: Replace ASIN with the product’s Amazon Standard Identification Number (e.g., 1234567890) or ISBN.
• template=: (Optional) Specify a layout: default, horizontal, or overlay. If omitted, it uses the default template set in Styling Settings.
• Examples:
  • : Displays the product in the Vertical layout.
  • : Uses the system default template (e.g., Vertical if unchanged).

Testing Mode

If Testing is enabled, the plugin only processes tags in articles with "paapi" as a keyword (set via article metadata). Disable Testing to process tags everywhere.

Requirements

Amazon Account: An active Amazon Affiliate account with Product Advertising API access.

Troubleshooting

• No Products Showing: Verify your Access Key, Secret Key, and Associate Tag are correct and that your Amazon account meets API requirements.
• Layout Issues: Check your template setting in the tag or plugin config; ensure your site’s CSS doesn’t conflict.
• Caching Problems: Adjust Cache Time or disable caching to test fresh API responses.