fast-simon-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.2.94 • Public • Published

sidebar_position: 1 title: Introduction

JavaScript SDK Library

For developer seeking to integrate the best E-commerce collections, filters, search, personalization and merchandising into their Frontend

Overview

The following document is for web developers seeking to utilize Fast Simon’s cloud service for Search, Collections and product recommendations. By using the described JavaScript SDK web developers can easily retrieve data to populate their search, collections and product recommendations.

Pre Installation Steps

  1. Go to Filters & Instant Search App Dashboard.
  2. Choose the Sync tab on the left.
  3. Main Settings > turn on "REST API".

Installation

CDN Global Script

<script src="https://assets.fastsimon.com/sdk/latest/fast_simon_sdk.js" async/>

NPM Package (Recommended)

npm install fast-simon-sdk

Initialization - CDN

Insert the following script at the head of your site as an async script after the original script injection

// using a cdn script will bind FastSimonSDK to window
document.addEventListener("DOMContentLoaded", function () {
    window.FastSimonSDK.initialization({
        storeID: 123, // store-id,
        uuid: "this-is-my-uuid", // uuid
        type: "SPA", // multi page application ("MPA") or single page application("SPA") (for reporting)
        onReady: () => {
            // do stuff
        }
    });
});

Initialization - NPM Package

import {FastSimonSDK} from "fast-simon-sdk"

// using a cdn script will bind FastSimonSDK to window
FastSimonSDK.initialization({
    storeID: 123, // store-id,
    uuid: "this-is-my-uuid", // uuid
    type: "SPA", // multi page application ("MPA") or single page application("SPA") (for reporting)
    onReady: () => {
        // do stuff
    }
});

Full Docs can be found here:

https://docs.fastsimon.com/sdk

Readme

Keywords

none

Package Sidebar

Install

npm i fast-simon-sdk

Weekly Downloads

50

Version

1.2.94

License

none

Unpacked Size

313 kB

Total Files

155

Last publish

Collaborators

  • npm
  • fast-simon