GuidesAPI Reference
Guides

Miva

Install the Miva module for Credit Key

Installing the Module on your Domain

  1. The name of the module is creditkey.mvc. Extract it from the ZIP file provided, if necessary.
  2. Log into your Miva Merchant administration backend (for example, https://www.domain.com/mm5/admin.mvc).
  3. Navigate to Settings > Domain Settings.
  4. Click on the Modules tab.
  5. Click the Add Module button.
  6. On the next screen, labeled "Add Module", click the Upload button.
  7. In the popup window, click the Choose File button (depending on your browser, the button label may be different).
  8. Navigate to the creditkey.mvc file on your hard drive and select it.
  9. Click the Upload button on the popup window.
  10. The popup window will disappear, returning you to the Add Module screen. Click the Add button near the top right.

Assigning the Module to your Store

  1. Navigate to Settings > Payment Settings.
  2. Click the ... button in the upper right, then choose Add/Remove Modules.
  3. Locate the Credit Key module. Click the Install button inside its box.
  4. If you have multiple stores on your domain, repeat steps 1–3 above for each store that you want to integrate with Credit Key.

Configuring the Module

  1. Go to Settings > Payment Settings and then click the Credit Key tab. It may be located under the "More" tab.
  2. Choose Staging or Production for the environment you want to use.
  3. Enter your public and private keys in the appropriate boxes.
  4. If desired, enter the minimum amounts at which promotional messaging will be displayed on the product detail page (PROD), the basket page (BASK) and during checkout (OSEL).
  5. Choose an alignment for the promotional messaging: right, left, or centered. This only affects the basket (BASK) page.
  6. Click the "Update" button in the top right to save your settings.

Create the User Interface Item

This should have been done for you when you installed the module. If not, perform the steps below.

  1. Click User Interface in the left column.
  2. Click Templates under the Advanced header in the middle column.
  3. Click on the Items tab.
  4. Click the "Add Item" button
  5. In the "Code" box, enter "creditkey".
  6. Click the "Look Up" button to find the Credit Key module.
  7. Click the "Add" button to create the item.

Assign the Item to the Pages

This should have been done for you when you installed the module. If not, perform the steps below.

  1. Click User Interface in the left column.
  2. Click Templates under the Advanced header in the middle column.
  3. Click the Items tab
  4. Search the Items list for an item with the code "creditkey"
  5. Click that item to edit it (click under the "Module" column)
  6. Click the "Pages" tab
  7. Assign the item to the pages "PROD" and "BASK" using the toggles in the "Assigned" column.
  8. If you do not see these pages, click the Filters dropdown in the upper right and choose "Show All".

Editing Placement of the Promotional Messaging

By default, the code for promotional messaging should have been added to the PROD and BASK pages on your store. These are controlled by placing the following tag in your store’s PROD and BASK page templates:

<mvt:item name="creditkey" param="container" />

To check whether this was added, or to move the tag to a new location on the page, perform the following steps:

  1. Click User Interface in the left column
  2. Click Templates under the Advanced header in the middle column.
  3. Search the page list for "PROD"
  4. Click "Product Display" – the page with "PROD" as its code
  5. Search the "Product Display Layout" template (not the main template) for the above tag
  6. If it's not there, add it. The suggested location is above the add to cart button
  7. If you wish to move the tag, you can delete its original location and add it in a new location. The promotional graphic will appear wherever you have added the tag

Editing Placement of the Promotional Messaging on BASK Page

Nearly identical steps are used for the basket page:

  1. Click User Interface in the left column
  2. Click Templates under the Advanced header in the middle column.
  3. Search the page list for "BASK"
  4. Click "Basket Contents" – the page with "BASK" as its code
  5. Search the "Basket Contents" template (not the main template) for the above tag
  6. If it's not there, add it. The suggested location is above the checkout button
  7. If you wish to move the tag, you can delete its original location and add it in a new location. The promotional graphic will appear wherever you have added the tag

Editing Placement of the Promotional Messaging on PROD Page With Page Builder

More recent installations of the Shadows ReadyTheme have the PROD page controlled by Page Builder instead of directly in the template. If this is true on your site, you must take additional steps to get the CreditKey messaging to appear.

First, make sure you are using version 10.06 or newer of the CreditKey module. Then complete the steps below.

Add the JavaScript Resource

  1. In the Miva admin, go to User Interface > Resources. Click the "JavaScript Resources" tab.
  2. Click the Add JavaScript Resource button
  3. In the box labelled Code, enter creditkey
  4. Change the Type dropdown to External File
  5. In the box labelled File Path, enter this value: https://unpkg.com/@credit-key/creditkey-js@latest/umd/creditkey-js.js
  6. Toggle off Global, but leave Active toggled on
  7. Click the Add button
  8. The creditkey resource should now appear in the list. Check the box next to it.
  9. Click the "…" button and choose Pages. Find PROD in the list and toggle it on. Then click the Close button
  10. Click the "…" button a second time and choose Resource Groups. Find footer_js in the list and toggle it on. Then click the Close button

Add the Fragment

  1. In the left column, under User Interface in the Advanced section, click Templates
  2. On the right side, click the tab called Fragments
  3. Click the Add Fragment button
  4. In the box labelled Name, enter CreditKey Marketing. In the box labelled Code, enter creditkey_marketing. Leave Start With set to Blank Fragment, and then click the Add Fragment button.
  5. On the next screen, check the box next to Public. Then enter the following code into the template box: <mvt:item name="creditkey" param="container|PROD" />
  6. Then click the Update button.
  7. Click the Items tab. In the list on the page, toggle the "creditkey" item to on.

Configure Page Builder

  1. Next, under User Interface in the left column, click Page Builder
  2. In the list, find "PROD" and you'll see on the same line that "Product Display" is a link. Click that link.
  3. Change the dropdown to "Sequence (sequence)" if it defaults to something else.
  4. Click Product Details
  5. Click Main Content
  6. Click Details. You should now see a list of "Details" starting with code, name, prices, etc.
  7. Click the link Add Detail: Level 3. It will add a new "Detail Name Here" at the bottom of the list.
  8. Click Detail Name Here. Change the Detail Name to something descriptive, such as "CreditKey Marketing"
  9. In the Type dropdown, select Feature: Fragment
  10. In the box labelled Fragment, enter creditkey_marketing, or use the Look Up button to find the fragment you added earlier.
  11. If you wish to change the location of the widget, click the left arrow icon near the top of the left column, beside the words "Detail: Level 3", to return to the previous page.
  12. In the list of details, it should show CreditKey Marketing at the bottom. Use the button with 6 dots to drag it to the desired place in the list.
  13. Click the Save button in the top right corner, Then you can close out of Page Builder by clicking the "X" in the top right corner.

Upgrading the Module on your Domain

The process to upgrade the Credit Key module on your store is similar to the installation process.

  1. Extract creditkey.mvc from the ZIP file provided.
  2. Log into your Miva Merchant administration backend (for example, https://www.domain.com/mm5/admin.mvc)
  3. Navigate to Settings > Domain Settings.
  4. Click on the Modules tab
  5. In the box labeled "Search Modules...", type in Credit Key and then click the Enter button.
  6. Click the entry in the table, in the Name column, where it says "Credit Key"
  7. On the next screen, click the "Files" tab.
  8. Click the "Upload" button.
  9. In the popup window, click the "Choose File" button (depending on your browser, the button label may be different.)
  10. Navigate to the new version of creditkey.mvc file on your hard drive and select it.
  11. Check the "Overwrite" checkbox.
  12. Click the "Upload" button on the popup window.
  13. The popup window will disappear, returning you to the Edit Module screen. Click the "Update" button near the top right.

Uninstalling the Module from your Store/Domain

Before you can uninstall the module, you will need to archive or delete any orders that use it. See https://docs.miva.com/reference-guide/regular-archiving for more information about archiving orders.

If you don't want to delete or archive orders, you won't be able to delete the module, but you can deactivate it altogether or disable the payment method in Payment Method Settings. See https://docs.miva.com/how-to-guides/how-to-payment-method-rules

Once that has been done, complete the following steps.

  1. Click User Interface
  2. Click Templates under the Advanced header in the middle column.
  3. Choose the Items tab
  4. Search for "creditkey". In the Code column, click "Credit Key".
  5. Click the Pages tab. Unassign the item from all pages to which it's assigned.
  6. Click the Item tab. Click the "…" button and choose Delete Item from the dropdown.
  7. Go to Settings > Modules
  8. Locate the "Credit Key" box, click the "…" button within its box, and choose "Uninstall". If you receive any errors, make sure you have completed the steps above.
  9. Repeat above steps for additional stores, if you have more than one on your domain.
  10. Go to Settings > Domain Settings.
  11. Click the Modules tab.
  12. In the "Search Modules..." box, type in Credit Key and click the Enter button
  13. Click the entry in the table, in the Name column, where it says "Credit Key"
  14. In the upper right of the next screen, click the "..." button, and choose "Delete Module"
  15. If you wish to leave the creditkey.mvc file on your server, uncheck the "Delete module file /mm5/5.00/modules/payment/creditkey.mvc" checkbox. Otherwise, leave it checked.
  16. Click the orange "Delete" button in the upper right.

Questions? Contact Credit Key Support