boxalino

Description

The Boxalino Client SDK provides a simple and efficient usage of Boxalino Search & Recommendations services (based on the p13n Thrift client libraries as separately provided in respective git-hub repositories) and to Boxalino Data Intelligence especially for Data Synchronization (define the structure of your data, push and publish your data structure configuration, push data in dev/prod and full/delta to Boxalino).

The Boxalino Client SDK are particularly interesting for integrators of Boxalino technologies and provides the following advantages compare to using the underlying API directly.

Install

Install it manually

npm install boxalino

or define this package as a dependency in your setup.

Usage

Example snippets on how the library can be used are to be found in examples folder If used in typescript file, you can import the library via:

import "boxalino";

or request targeted classes depending on your extension use:

import {BxClient, BxChooseResponse, BxRecommendationRequest} from "boxalino";

In the code, use the boxalino library by:

var boxalino = require('boxalino');
var bxClient = boxalino.BxClient(account, password, isDev, host);
bxClient.setApiKey(<api-key>);
bxClient.setApiSecret(<api-secret>);

and adding BxRequest() objects depending on your use-case. Check the code samples in the tests folder or get in touch with your Boxalino contact.

Thrift

This package contains server-generated files for Apache Thrift 0.10.0 version which are located under bxthrift folder