<img height="1" width="1" style="display:none" src="https://q.quora.com/_/ad/ad9bc6b5b2de42fb9d7cd993ebb80066/pixel?tag=ViewContent&amp;noscript=1">

Search Engine API Documentation

Loop54 Search is a learning search engine for e-commerce. It helps online shoppers find what they’re looking for, and allows them to explore a wider range of relevant products in a retailer’s catalogue.

This document will guide you through setting up communication with the engine, creating requests, catching responses and a step-by-step guide to set up a basic implementation for searching and related features.
 
We have built a reference implementation in Javascript that we have made public on GitHub and encourage you to use. If you prefer other software platforms, libraries are available for PHP, .NET and Java.

 

Settings.svg

The engine

The engine exposes a REST-like web API used for searching, filtering, tracking user behaviour and any custom features configured for a particular installation. The functions are called using HTTP POST requests with a set of JSON request parameters, after which the engine responds with JSON data.

Search.svg

Demo

All examples in this guide use the engine at helloworld.54proxy.com. It uses the products in products.json, and you can check out the results at the following link: HelloWorld demo. This demo implements most features in the documentation.

Platform_libraries.png

Libraries

For some of the most common platforms, libraries are available in order to streamline the implementation process. We have connectors for simple integrations with the following programming languages: Javascript, PHP, .NET and Java

Implementation guide

Most of this documentation consists of an implementation guide with code samples. You can use this guide to learn about what features Loop54 offers, and how to implement them. All new implementations should follow our version 3 API documentation.

Product feed

What requirements the engine has on the feed from which it fetches products. 

Version 2 API           Version 3 API

AutoComplete

Implementing the autocomplete (also called type-ahead) feature. 

Version 2 API           Version 3 API

Category listings

This is how you implement category navigation using Loop54.

Version 2 API           Version 3 API

Search

How to implement Search, including features such as spelling suggestions, related queries and handling errors.

Version 2 API           Version 3 API

Boost and bury rules

Apply your business logic to sorting. Boost or bury search results or category listings based on any product attribute. 

Version 2 API           Version 3 API

Faceting

How to faceting works and how to implement it in Search and other requests.

Version 2 API           Version 3 API

Event tracking

Tracking of clicks, purchases and other user events.

Version 2 API           Version 3 API

Custom sorting and filtering

You can sort and filter results to fit your requirements. 

Version 3 API         

 

 

Syncing the product catalog

Loop54 must be notified to sync the changes made to your product catalog.

 Version 3 API      

Find out what it takes to go live

The Loop54 implementation process is broken into six phases. Review and download the detailed timetable.