@glance-networks/glance-web-sdk
v0.1.12
Published
A SDK for the Glance Web API
Keywords
Readme
@glance-networks/glance-web-sdk
Current package version: 0.1.12
Overview
The Glance Web SDK provides browser-side APIs for integrating Glance-assisted support and digital engagement experiences into your web application. It includes the core session lifecycle, visitor and agent entry points, and optional UI helpers for common integration flows.
For full product documentation, concepts, and API reference, see docs.glance.cx.
Prerequisites
Before you start, you'll need:
- A Glance group — this is your organization's account with Glance.
- Your Group ID OR Partner ID — a numeric identifier for your Glance group, used when creating an agent (
groupId/partnerid). - Partner User ID — credentials that specify a particular user for your Glance group, used for authentication (
partneruserid). - A LoginKey — an HMAC generated per session/login attempt. See the login-key guide for how to generate one.
If you don't have these yet, contact Glance.
Installation
npm install @glance-networks/glance-web-sdkBasic usage
import {
createWebCore,
createWebSdk,
createDefaultUi,
getReleaseIdentity,
} from "@glance-networks/glance-web-sdk";
const release = getReleaseIdentity();
console.log(release.id);You can also import focused entry points:
import { createVisitor, createAgent } from "@glance-networks/glance-web-sdk/web-sdk";
import { createWebCore } from "@glance-networks/glance-web-sdk/web-core";
import { createDefaultUi } from "@glance-networks/glance-web-sdk/web-default-ui";
import { createLauncher } from "@glance-networks/glance-web-sdk/launcher";Visitor example
import { createVisitor } from "@glance-networks/glance-web-sdk/web-sdk";
const visitor = createVisitor({
groupId: 12345,
webserver: "https://www.glance.net",
clientVersion: "5.1.0",
});
await visitor.initialize();
await visitor.start({ consentGranted: true });Agent example
import { createAgent } from "@glance-networks/glance-web-sdk/web-sdk";
const agent = createAgent({
groupId: 12345,
webserver: "https://www.glance.net",
});
agent.authenticate({
partnerid: "...",
partneruserid: "...",
loginkey: "...",
});Package contents
This package ships the source entry points under src/ and the generated distributable packages under dist/. Test fixtures, demos, planning notes, and other repository-only files are not included in the published artifact.
Support
See the integration material in docs/ and your Glance implementation guidance for environment-specific configuration and rollout details.
