diff --git a/GUIDE.md b/GUIDE.md new file mode 100644 index 0000000..29db188 --- /dev/null +++ b/GUIDE.md @@ -0,0 +1,45 @@ +# Using the BitPay plugin for ECWID + +## Prerequisites +You must have a BitPay merchant account to use this plugin. It's free to [sign-up for a BitPay merchant account](https://bitpay.com/start). + + +## Installation & Configuration + +**In config.php:** + +- Set $storeURL to the URL of your store's homepage. +- Set $storeID to your ecwid store ID found in the bottom-right of the Ecwid control panel. +- Set $bitpayURL to the URL of the bitpay/ folder which you extracted from this plugin. +- Set $apiKey to the key you created at bitpay.com in the "My Account > API Access Keys" section. +- Adjust $speed if desired. + +**In your Ecwid control panel:** + +- Click System Settings > Payment, then click Authorize. Rename this to "Bitpay" or whatever you'd prefer. +- Change Payment Processor to Credit Card: Authorize.net SIM +- Click Account Details +- API Login ID: choose something random here and copy it to config.php's $login variable. +- Transaction Key: choose something random +- MD5 Hash value: choose something random here and copy it to config.php's $hashValue variable. +- Transaction Type: Authorize and Capture. +- Click Advanced Settings. +- Type in the url to bitpay/redirect2bitpay.php on your server. +- Click Save +- Click Save +- Click Design > CSS Themes +- Either click "New CSS Theme" or edit your own theme. +- Add this to the text area of your custom theme: +```css + /* bitpay checkout image */ + img.defaultCCImage { + padding: 25px 263px 0px 0px; + background: url('https://en.bitcoin.it/w/images/en/2/29/BC_Logo_.png'); + background-size:auto; + background-repeat:no-repeat; + width:0px; + height: 0px; + } +``` +- Click Save + diff --git a/README.md b/README.md index ea6db93..d7d63c0 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,15 @@ -©2011-2015 BITPAY, INC. +# Description -The MIT License +Bitcoin payment plugin for Ecwid using the bitpay.com service. -Permission is hereby granted to any person obtaining a copy of this software and associated documentation for use and/or modification in association with the bitpay.com service. -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. +## Quick Start Guide + +To get up and running with our plugin quickly, see the GUIDE here: https://github.com/bitpay/ecwid-plugin/blob/master/GUIDE.md + + +## Troubleshooting -Bitcoin plugin for Ecwid using the bitpay.com service. - - - -Instructions ------------- -In config.php: -- Set $storeURL to the URL of your store's homepage. -- Set $storeID to your ecwid store ID found in the bottom-right of the Ecwid control panel. -- Set $bitpayURL to the URL of the bitpay/ folder which you extracted from this plugin. -- Set $apiKey to the key you created at bitpay.com in the "My Account > API Access Keys" section. -- Adjust $speed if desired. - -In your Ecwid control panel: -- Click System Settings > Payment, then click Authorize. Rename this to "Bitpay" or whatever you'd prefer. -- Change Payment Processor to Credit Card: Authorize.net SIM -- Click Account Details -- API Login ID: choose something random here and copy it to config.php's $login variable. -- Transaction Key: choose something random -- MD5 Hash value: choose something random here and copy it to config.php's $hashValue variable. -- Transaction Type: Authorize and Capture. -- Click Advanced Settings. -- Type in the url to bitpay/redirect2bitpay.php on your server. -- Click Save -- Click Save -- Click Design > CSS Themes -- Either click "New CSS Theme" or edit your own theme. -- Add this to the text area of your custom theme: -
- /* bitpay checkout image */
- img.defaultCCImage {
- padding: 25px 263px 0px 0px;
- background: url('https://en.bitcoin.it/w/images/en/2/29/BC_Logo_.png');
- background-size:auto;
- background-repeat:no-repeat;
- width:0px;
- height: 0px;
- }
-
-- Click Save
-
-
-Troubleshooting
----------------
The official BitPay API documentation should always be your first reference for development: https://bitpay.com/downloads/bitpayApi.pdf
- Verify that your "notificationURL" for the invoice is "https://" (not "http://")
@@ -62,8 +22,20 @@ The official BitPay API documentation should always be your first reference for
- If all else fails, send an email describing your issue in detail to support@bitpay.com
-Version
--------
+## Version History
+
- Bitpay plugin version 1.0
- Tested against Ecwid version 13.0.1629
- Added new HTTP header for version tracking
+
+
+## License
+
+©2011-2015 BITPAY, INC.
+
+The MIT License (MIT)
+
+Permission is hereby granted to any person obtaining a copy of this software and associated documentation for use and/or modification in association with the bitpay.com service.
+
+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.
+