Integraize SDK

SDK for integrating Integraize chat widgets into different platforms.

Features

• Lightweight and fast integration
• Seamless iframe-based embedding
• Dynamic resizing for adaptive layouts
• Cross-browser and cross-device compatibility
• Simple API for controlling the chat widget

Installation

Via npm (Recommended)

npm install integraize-sdk

Then import it in your code:

// ESM
import { Integraize } from 'integraize-sdk';

// CommonJS
const { Integraize } = require('integraize-sdk');

Via CDN

<script src="https://unpkg.com/@integraize/sdk@latest/dist/index.umd.js"></script>

Quick Start

// Initialize the SDK
Integraize.init({
  userId: 'unique-user-id',
  apiUrl: 'https://api.integraize.com', // optional
  locale: 'uk', // optional, default 'uk'
  autoOpen: false, // optional, default false
  theme: {
    primaryColor: '#a0c96d' // optional
  }
});

// Getting an instance
const chatbot = Integraize.getInstance();

// Opening a chat
chatbot.open();

// Close the chat
chatbot.close();

// Status check
const isOpen = chatbot.isOpen();

// Status switch
chatbot.toggle();

Configuration Options

| Option | Type | Required | Description | |--------|------|----------|-------------| | userId | string | Yes | Unique user identifier | | apiUrl | string | No | API server URL (default: 'https://api.integraize.com') | | locale | string | No | Locale (default: 'uk') | | autoOpen | boolean | No | Automatically open chat (default: false) | | theme.primaryColor | string | No | Theme primary color (default: '#a0c96d') |

API Methods

Initialization

// Initialize the SDK with configuration
Integraize.init({
  userId: 'user123',
  apiUrl: 'https://api.integraize.com',
  locale: 'uk',
  autoOpen: false,
  theme: {
    primaryColor: '#a0c96d'
  }
});

Chat Control

// Get an instance
const chatbot = Integraize.getInstance();

// Open the chat
chatbot.open();

// Close the chat
chatbot.close();

// Toggle chat visibility
chatbot.toggle();

// Check if chat is open
const isOpen = chatbot.isOpen(); // returns boolean

Event Handling

// Get an instance
const chatbot = Integraize.getInstance();

// Subscribe to events
chatbot.on('open', () => {
  console.log('Chat was opened');
});

chatbot.on('close', () => {
  console.log('Chat was closed');
});

// Unsubscribe from events
chatbot.off('open', callback);

Development

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build
npm run build

# Run tests
npm test

# Linting
npm run lint

License

MIT