Using Javascript Tagging Library - 1.4

Owned by Lara Menéndez García (Unlicensed)
Last updated: Aug 21, 2019 by Beltrán García Balbuena (Unlicensed)
1 min read

Overview

Instructions to use Javascript Tagging Library.

Upgrading from v1.3

BREAKING CHANGES
  • Updated parameter list in trackClick, trackAdd2Cart & trackWishList :
    • Added position & productID added.
    • scope moved to options

Changelog (v1.4)

v1.4.0:

  • Add browse events API
  • Update trackClick, trackAdd2Cart & trackWishList to latest API spec
  • Turn scope from a function parameter to an option, for consistency

Step-by-step guide

First of all, you need your INSTANCE_ID (i.e. client-instance-id) from our Account Manager, Appointed Lead Developer or alternatively contact our Support team. The possible values for ENVIRONMENT are: 'live' (to use in live environment) and 'staging' (to use in staging environment).


The library must be included inside your code before using the API. This piece of code should be inserted at the bottom of the page:

STAGING environment resources import

<script src="https://assets.empathybroker.com/apijs/1.4/empathy.resources.js" type="text/javascript"></script>


LIVE environment resources import

<script src="https://assets.empathybroker.com/apijs/1.4/empathy.resources.min.js" type="text/javascript"></script>


Usage

Once the library is added to the page, you need to create an instance of the service (It is no longer necessary to call the init() method):

var empathyTAG = new EmpathyBrokerTAG(INSTANCE_ID, ENVIRONMENT, CONSENT);

PD: consent it has to be send it as 'true' when the user accept the cookies, if not, you have to send 'false'.


Example

var empathyTAG = new EmpathyBrokerTAG('client-instance-id', 'staging', true);

At this point, you are ready to use the library:


Note: If you need to see requests received visit URL_EMPATHYBROKER/services/log/last