Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Instructions to use Javascript Search Library.

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: 'liv' (to use in live environment) and 'stag' (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

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


LIVE environment resources import

Code Block
languagexml
<script src="https://assets.empathybroker.com/apijs/1.3/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):

Code Block
languagejs
var empathySearch = new EmpathyBrokerSearch(INSTANCE_ID, ENVIRONMENT);

Example

Code Block
languagejs
var empathySearch = new EmpathyBrokerSearch('client-instance-id', 'stag');

...

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "empathy-search-api-javascript" and parent = "78384682"

Filter by label (Content by label)
cqllabel = "empathy-search-api-javascript"