affiliate-sdk-web
v0.9.0
Published
Affiliate App Web SDK
Readme
Affiliate App Web SDK
Web SDK solution for Affiliate
Installation
You can use this package with cdn or package manager.
1. Installation using package managers
npm install affiliate-sdk-webor
yarn install affiliate-sdk-web2. Installation using CDN
This package is available on jsDelivr.
https://cdn.jsdelivr.net/npm/affiliate-sdk-web@latest/dist/affiliate.min.js
Asynchronous installation
<script type="text/javascript">
var Affiliate = Affiliate || {};
// Load Affiliate script asynchronously
(function() {
var cly = document.createElement('script'); cly.type = 'text/javascript';
cly.async = true;
// Enter url of script here (see below for other option)
cly.src = 'https://cdn.jsdelivr.net/npm/affiliate-sdk-web@latest/dist/affiliate.min.js';
cly.onload = function(){Affiliate.init('<your-key>')};
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(cly, s);
})();
</script>Synchronous installation
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/affiliate-sdk-web@latest/dist/affiliate.min.js"></script>
<script type="text/javascript">
Affiliate.init('<your-key>');
</script>Quickstart
To initialize Affiliate instance and send events...
1. Install
npm install affiliate-sdk-web2. Initialize Affiliate instance
(ES6 module syntax)
import * as Affiliate from 'affiliate-sdk-web';
Affiliate.init('<your-key>');... or using CommonJS syntax:
const Affiliate = require('affiliate-sdk-web');
Affiliate.init('<your-key>');3. Send Order Event
<button id="btnPayment">Send Order Event</button>const btnPayment = document.getElementById('btnPayment');
btnPayment.addEventListener('click', () => {
Affiliate.send('order', {
orderId: 'Ox001',
currency: 'TRY',
price: 1375,
paidPrice: 1380, // Including shipping fee
items: [
{
categoryId: 'Cx001',
price: 1000,
productName: 'Product Name 1',
productId: 'product-id-1'
},
{
categoryId: 'Cx002',
price: 250,
productName: 'Product Name 2',
productId: 'product-id-2'
},
{
categoryId: 'Cx003',
price: 125,
amount: 2, // This is not required field
productName: 'Product Name 3',
productId: 'product-id-3'
}
]
});
});