<img src="https://secure.leadforensics.com/84962.png" style="display:none;">

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 also built a reference implementation in JavaScript that we have made public on GitHub and encourage you to use.

Search API 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. It is divided into the following sections:

Product feed

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

Category listings

If you want to implement your category navigation using Loop54, this is how you do it.

Best practices

A list of common pitfalls and tips on how to implement Loop54 successfully.

Search

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

Faceting

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

Checklist

We've compiled a checklist of all the features in this documentation.

AutoComplete

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

Event tracking

Tracking of clicks, purchases and other user events.

Find out what it takes to go live

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