Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.28 KB

README.md

File metadata and controls

90 lines (56 loc) · 3.28 KB
Raw

FoxyCart helper plugin for Craft CMS

This plugin adds in a number of FoxyCart features to Craft to make it easier for you to add a FoxyCart powered checkout to your site.

Features

  • Webhooks
  • SSO
  • HMAC add to cart link/form validation
  • FoxyCart category field
  • Basic transaction reports

Requirements

Installation

  1. Copy the folder into your Craft CMS plugins folder
  2. Navigate to the plugins section of the CP and install the FoxyCart plugin
  3. Edit the plugin settings to set your FoxyCart store domain and API key

Usage

For an overview of integrating FoxyCart into Craft utilising this plugin, see Craft CMS integration notes on the FoxyCart wiki

HMAC

To enable HMAC validation, simply wrap any links or forms (or your whole page if desired) in {% hmac %} and {% endhmac %} tags. Note that the add to cart requires a code. For more information see this page

Events

foxyCart.onProcessWebhook

Raised whenever a webhook (transaction or subscription) is processed.

Params:

  • xml – A decrypted SimpleXMLElement instance of the received webhook payload.
  • feedType - A string describing the type of webhook received ("transaction" or "subscription")

Variables

  • craft.foxyCart.storedomain - The store subdomain as set in your plugin settings.

Fields

  • FoxyCart Category - Displays a dropdown of the categories as set within the FoxyCart store

Reports

This plugin includes some very basic reports accessible from the "FoxyCart" CP section. This is more of a proof of concept currently than a full-fledged reports area. Currently when Craft is in devMode, test transactions are displayed, otherwise live transactions are displayed.

Debugging

Some helpful debug messages are logged to a plugin specific log file of foxycart.log.

Got an improvement or found a bug?

We're accepting pull requests! All we request is that any changes you make remain accessible to all users of the plugin.

Changelog

v1.0

  • Initial commit

License

Copyright (c) 2014 FoxyCart, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included 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 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.