kinformation / grav-plugin-amazon-products

The Amazon Products Plugin is for Grav CMS. Displays Amazon products by ASIN/ISBN-10 on your pages.
MIT License
8 stars 3 forks source link

Amazon Products Plugin

The Amazon Products Plugin is for Grav CMS. Displays Amazon products by ASIN/ISBN-10 on your pages.

Installation

Installing the Amazon plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install amazon-products

This will install the Amazon plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/amazon-products.

Manual Installation

NOTE: This plugin depends on Shortcode Core, so you need to install it in advance.

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to amazon-products. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/amazon-products

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/amazon-products/amazon-products.yaml to user/config/plugins/amazon-products.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
keys:
  accessKeyId: "your AWS Access Key ID"
  secretAccessKey: "your AWS Secret Access Key"
  associateTag: "your Amazon AssociateTag"
locale: "US"

This plugin requires Amazon Product Advertising API Access Key ID and Secret Access Key. Please register with AWS and obtain Access Key ID and Secret Key.

Usage

[amazon asin=059035342X][/amazon]
or
[amazon asin=https://www.amazon.com/Harry-Potter-Sorcerers-Stone-Rowling/dp/059035342X/ref=sr_1_1...][/amazon]

Book

[amazon asin=059035342X][/amazon]

Music CD

[amazon asin=B01LX4X7K0][/amazon]

Video

[amazon asin=B01B80CM4W][/amazon]

Other

[amazon asin=B015WXL0C6][/amazon]

NOTE: If you do not see your ad, please check the following.

  • The validity of your AWS Access Key IDs.
  • Whether you can acquire the item XML you specified. You can check with Product Advertising API Scratchpad
  • Check config of PHP extension suhosin. suhosin.executor.include.whitelist = phar, plugin
  • "OK" is checked for Translations enabled and Translations fallback in the system setting