universal-search-engine-api

UniversalSearchEngine - JavaScript client for universal-search-engine-api universal search engine api

Installation

For Node.js

npm

Then install it via:

npm install universal-search-engine-api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var UniversalSearchEngine = require('universal-search-engine-api');

var api = new UniversalSearchEngine.SearchApi()

var name = "name_example"; // {String} name of index to be created

var type = "type_example"; // {String} type of index, should be Simple_Search or Ecommerce

var API_KEY = "API_KEY_example"; // {String} API_KEY for authentication


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addIndex(name, type, API_KEY, callback);

Documentation for API Endpoints

Method | HTTP request | Description ------------- | ------------- | ------------- addIndex | POST /addIndexByApi | Add Index By Api addObject | POST /add/{index_name} | This will add an object to the given index. addObjects | POST /bulkadd/{index_name} | This will add an array of objects to the given index. copyIndexConfig | POST /copyIndexConfig | Copy Index configuration from one index to another deleteAllData | DELETE /deleteAllData/{index_name} | Delete Index deleteIndex | DELETE /deleteIndexByApi | Delete Index deleteObject | DELETE /delete/{index_name} | This will delete the object with given object id generateEvent | POST /event/{index_name} | This will generate an event. getAllIndices | GET /getAllIndices | Get all Indices getAllObjects | POST /getAllObjects | Get All objects stored in index searchQuery | POST /search/{index_name} | Search for a query in an index

Documentation for Models

• UniversalSearchEngine.ModelObject
• UniversalSearchEngine.Object1
• UniversalSearchEngine.SearchParameters

Documentation for Authorization

All endpoints do not require authorization.