APXOR Web SDK Integration Guide

Apxor Web SDK Integration

Plugin Name	Latest Version	Release Date
apxor-web-sdk-core	1.9.0	2023-05-29
apxor-web-sdk-rtm	1.4.1	2023-05-29
apxor-web-sdk-ce	1.1.9	2023-05-17
apxor-web-sdk-rtm-ui-only	0.0.9	2022-10-19

To add Apxor SDK into your Website, run the following command

npm install --save apxor

SDK Initialization

Import Apxor sdk and initialize it in application root component or page

import Apxor from "apxor"; // ES6

Apxor.init("YOUR_SITE_ID", {
  // Initialization options
});

You can find the description and default values for Initialization options here

Note:

Contact support@apxor.com to get your unique SITE_ID

Initialize Plugins

• Run the following command in your terminal

npm install --save apxor-qe apxor-rtm

• Add the following import statements in your root component or page to make sure that these two packages will be bundled when you build your Website

import CE from "apxor-qe";
import ApxorRTM from "apxor-rtm";

• Add the following values in Initialization option's plugin and deps array

Apxor.init("YOUR_SITE_ID", {
  // ...
  plugins: ["ApxorRTM"],
  deps: [ApxorRTM, CE],
  version: "<YOUR_WEBSITE_VERSION>", // Optional
  // ...
});

API Guide

Read API Guide here