Loop54

Loop54 Technical Documentation

Work in Progress 🏗️ This documentation covers our newly released version 3 API. If you are looking for the older version 2 documentation you find it here!

Introduction

This document explains how to implement Loop54. We’ve done our best to make implementation as easy as possible and we hope you like it!

Our technical documentation consists of three sections:

  • A step-by-step developer guide to set up a basic implementation for searching and related features. This section will guide you through setting up communication with the engine, creating requests, receiving responses and sending the correct events back to the search engine.
  • Connectors for simple integrations with the following programming languages: Javascript, PHP, .NET and Java
  • An extensive API reference allows you to customise your integration as you want

Developer Guide

The developer guide provides a technical overview of what aspects to consider when implementing the Loop54 search engine. A typical implementation will follow the steps below, follow the link under each step for more details.

This guide assumes that you are using one of our Connectors and the examples shown are demonstrated with code examples for each connector. The same functionality as demonstrated here can of course be achieved by interfacing our API directly.

Step 1 - accessing the Loop54 API

Integration and interaction with the Loop54 search engine is done via our API.

Step 2 - setting up the product feed

Loop54 indexes all your products and makes them easy to find for searching end users. You will need to generate a feed describing all your products containing all attributes and metadata that is relevant in order to deliver relevant search results.

Step 3 - syncing the product catalog

When your product catalog is updated Loop54 must be notified to sync the changes.

Step 4 - implementing search functionality

This step gives an introduction to how to implement search functionality and you should also read steps 5, 6 & 7 about autocomplete and custom sorting and filtering.

Step 5 - implement autocomplete

You will want to provide your users with search suggestions as they type.

Step 6 - faceting

This guide explains how to add faceting to your search results.

Step 7 - custom sorting and filtering

The Loop54 search engine is highly configurable and you can sort and filter results to fit your requirements.

Step 8 - sending events

The Loop54 search engine is a learning engine that automatically improves search result relevance based on user interactions. To be able to achieve this, the implementation must send said user interactions as events to the API. A normal implementation must send Click, AddToCart and Purchase events for optimal operation.

Step 9 - category listings

In addition to search, the Loop54 engine can also provide category listings of your catalog. All the benefits of Loop54’s clever personalisation and session intent sorting can then be applied to the order of listed products.

Connectors

To simplify your integration, we have created convenience connectors that takes care of everything you normally need in a standard integration such as handling user ID cookies, forwarding client metadata, JSON serialization and HTTP plumbing.

If you are using a programming language not listed below or require a customised integration please refer to the API reference.

If you want a general overview of what a Loop54 implementation should contain, please refer to our developer guide

Select the programming language relevant to you from the list below.

.NET

Java

JavaScript

PHP

API Reference

If your programming language isn’t represented in the list of Connectors you can integrate directly with our API.

Loop54 API reference

OpenAPI JSON Schema