Three steps, with examples

Export your history

A text file with no header. Each row is a purchase: the customer, a semicolon, the product.

C0042;coffee-beans-1kg
C0042;descaler
C0117;coffee-beans-1kg
C0117;cups-set-6

Load it

From the Facts Archive in the web app or through the API. The import runs in the background, in blocks of 5,000 rows, and you can follow it under "Recent imports". Reloading an archive with the same name replaces it.

Your system asks for suggestions

For a customer it makes a GET request with their code. For a cart it makes a POST request with the list of products, as in the example below. The response always has this shape.

GET /api/suggestions/noratings/users/C0042/sales?minscore=60&max=5

{
  "_count": 1,
  "items": [
    { "prod": "cups-set-6", "score": 72.5 }
  ]
}

For a cart

Your system sends the products the cart contains. The response has the same shape as the one for a customer.

POST /api/suggestions/noratings/products/sales?minscore=60&max=5

{ "products": ["coffee-beans-1kg", "descaler"] }

Parameters

Parameter	Meaning	Default
`minscore`	Minimum score, from 0 to 100	60
`max`	Maximum number of products returned, up to 100	10

How the score is calculated is explained in How it works.

What you need

A file with two columns separated by a semicolon. Empty lines and lines starting with # are ignored. An empty field causes the file to be rejected, and the file is checked before loading.
The archive name uses letters, digits and underscores, starts with a letter and is up to 30 characters long.
Identifiers used in API requests contain letters, digits, hyphens and underscores, and are up to 100 characters long. Spaces are not allowed.
Suggestion requests need an access token.

Need a hand?

At bit Time Professionals we look after the connection: training on integrating with the software you already use, and support. We talk about it after the demo.

Visit statistics

Integration