How To Integrate Avelon With Your Website

Avelon offers multiple, easy ways to integrate with your website to start tracking purchases from affiliates. For those on established eCommerce platforms, please see these pre-built plugin guides below:

• Shopify Guide
• WooCommerce Guide
• Citrus Lime Guide
• CraftCMS Guide (coming soon)
• Etsy Guide (coming soon)
• SquareSpace Guide (coming soon)
• Magento Guide (coming soon)
• Custom websites

For those using bespoke eCommerce solutions or for platforms not currently supported by an Avelon plugin, please see our full implementation guide.

Ecommerce Plugins

Our eCommerce plugins currently support Shopify and WooCommerce. They work by storing a unique affiliate id in the customer's browser and then send some product and general purchase data to our system upon a successful transaction.

This allows you to grant commission payments to the affiliate(s) that drove the sale based on the order value of your purchased items.

For the full specification of what data Avelon receives from our plugins please see our Purchase API documentation here.

Shopify - Avelon App

You can find our plugin for Shopify by searching for 'Avelon Network' in the Shopify Apps menu in your Shopify account or here: https://apps.shopify.com/avelon-network

Once the Shopify app is loaded you'll be served instructions and two configuration fields (text inputs).

You'll find your account details and API Token button in the first section under settings at: https://app.avelonetwork.com/provider/settings

Creating API tokens is easy. After clicking on the 'Avelon API tokens' button in the Account Information section. Click on the '+ Generate' button. You can click on the actual anonymised code or the copy button on the far right to copy the API token.

Copy your account name & API token into the required fields and click 'Save'.

Congratulations! You're now all set to use Avelon Network with your Shopify Store.

Wordpress / WooCommerce - Avelon Plugin

You can either upload the plugin for WooCommerce or install the plugin via the WooCommerce Plugin directory:

To install via the Plugin directory:

Avelon Network

Plugin to connect Avelon Network to woocommerce.

WordPress.orgpixable

1. Once you've installed the Avelon Plugin, head to your Settings in your Account page. Copy your Account ID by clicking the clipboard next to your Account ID. Paste this into the Account ID field in the Wordpress/WooCommerce application you've just installed on your site.

2. Create an API token and copy it into the API token box in the application. Creating API tokens is easy. After clicking on the 'Avelon API tokens' button in the Account Information section. Click on the '+ Generate' button. You can click on the actual anonymised code or the copy button on the far right to copy the API token.

3. Copy your account name & API token into the required fields and click 'Save'.

Congratulations! You're now all set to use Avelon Network with your Wordpress/WooCommerce Store.

To install via a plugin upload (not recommended)

Please note: this method is only recommended if you are not on a WooCommerce Basic Plan which does not allow for Plugin Directory access, but allows Plugin .zip file uploads.

1. When you've signed up, you'll be provided a .zip file from your Account Manager. Download this .zip file.

2. From your WordPress dashboard, choose Plugins > Add New.

3. Click Upload Plugin at the top of the page.

4. Click Choose File, locate the plugin .zip file, then click Install Now.

5. After the installation is complete, click Activate Plugin.

6. Head to your Settings in your Account page. Copy your Account ID by clicking the clipboard next to your Account ID. Paste this into the Account ID field in the Wordpress/WooCommerce application you've just installed on your site.

7. Create an API token and copy it into the API token box in the application. Creating API tokens is easy. After clicking on the 'Avelon API tokens' button in the Account Information section. Click on the '+ Generate' button. You can click on the actual anonymised code or the copy button on the far right to copy the API token.

8. Copy your account name & API token into the required fields and click 'Save'.

Congratulations! You're now all set to use Avelon Network with your Wordpress/WooCommerce Store.

Citrus Lime

Installation via the Citrus Lime eCommerce platform is a two-way street and mainly follows the same outlines for Bespoke Website Integrations (below). This method is outlined below:

Step 1. Contact your Citrus Lime representative

Contact your Citrus Lime representative or the Citrus Lime Helpdesk and ask them to install the Avelon Network integration. If they're unsure of what that is, just ask them to install the same integration as Redpost Equestrian or SouthDownsBikes.

They'll need to perform the below integration:

Step 2. Head Tag

This tag needs to go in the <head> of every page:

<script src="https://{{accountname}}.avln.me/t.js"></script> - please insert your copied account name as the subdomain value.

This script has the sole purpose of taking the Avelon Click URL parameter (avln_cid) and setting it as a first party cookie for use when sending the purchase POST data.

Step 2. Purchase POST request to the Avelon API

The Purchase POST request allows us to gain visibility on purchases and their data which we then attribute back to the affiliate and use to calculate commission on a item by item basis.

Full developer documentation can be found here: https://avln.me/api/latest/index.html

Please send the POST request to this end point: https://{{accountname}}.avln.me/purchase

Your account name is required once again in the subdomain value.

*Any purchase that does not contain our Avelon Click ID (avln_cid) or a promo code not present and assigned to an affiliate on our platform is not recorded.

For any questions regarding bespoke integrations, please use the contact form in the Avelon App.

Bespoke Website Integrations

Bespoke website integrations have been designed to be as simple as possible. There are two parts to this process and should be an easy task for your developer.

Step 1. Head Tag

This tag needs to go in the <head> of every page:

<script src="https://{{accountname}}.avln.me/t.js"></script> - please insert your copied account name as the subdomain value.

This script has the sole purpose of taking the Avelon Click URL parameter (avln_cid) and setting it as a first party cookie for use when sending the purchase POST data.

Step 2. Purchase POST request to the Avelon API

The Purchase POST request allows us to gain visibility on purchases and their data which we then attribute back to the affiliate and use to calculate commission on a item by item basis.

Full developer documentation can be found here: https://avln.me/api/latest/index.html

Please send the POST request to this end point: https://{{accountname}}.avln.me/purchase

Your account name is required once again in the subdomain value.

*Any purchase that does not contain our Avelon Click ID (avln_cid) is not recorded.

For any questions regarding bespoke integrations, please use the contact form in the Avelon App.