Versions Compared

Key

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

...

If you want integrate our features in your own dashboard, you could create synonyms using our public Play API. It’s really easy. For example, if you were using Python, you could do something like this:

import requests, logging


# login using user service to get a valid token

user_request = requests.post('https://api.empathybroker.com/user/v1/user/login',

                             json={'email': 'YOUR_EMAIL', 'password': 'YOUR_PASSWORD'})


if user_request.status_code != 200:

    logging.error('Error %s requesting user token: %s', user_request.status_code, user_request.text)

    return


login = user_request.json()

logging.info('Login succeeded')


data = {

    "synonyms": ["luggage", "suitcase"],

    "lang": "en",

    "type": "basic",

    "enabled": True,

    "extra": {

        "user": "myemail@company.com"

    }

}


# create a synonym requesting play service

synonym_request = requests.post('https://api.empathybroker.com/play/v1/YOUR_INSTANCE/synonyms',

                                json=data,

                                headers={'Authorization': 'Bearer ' + login['user_token']})


if synonym_request.status_code > 299:

    logging.error('Error %s creating synonym: %s', synonym_request.status_code, synonym_request.json())

    return


logging.info('Synonyms created %s', synonym_request.json())


In summary

Synonyms help avoid those dreaded no-results pages. Knowing how and when to implement them is essential for a well-tuned search experience. To find out more about Synonyms and User endpoints refer to the API documentation for your environment or read more in our blog here.

...