Kanmon Web SDK

The Kanmon Web SDK provides an easy-to-use interface for developers to integrate Kanmon's embedded UI into their web applications.

Installation

NPM

npm install @kanmon/web-sdk

Yarn

yarn add @kanmon/web-sdk

Usage

Initializing the Embedded UI Component

Before interacting with our Web SDK, you must have a valid Kanmon Connect Token. For more information on how to acquire one of these for your user - please refer to our Connect Token API Docs. You can also read our Quick Start Guide for steps 1 and 2, where as step 3 should be replaced with this SDK. Note that the Connect Token api endpoint should be hit from your backend to ensure security of your API key.

Typically, this is done on page load as to have the embedded Kanmon UI ready for use when needed.

import { KANMON_CONNECT, KanmonConnectParams } from '@kanmon/web-sdk'

const config: KanmonConnectParams = {
  connectToken: 'CONNECT_TOKEN',
  // Optionally set the environment to 'SANDBOX' or 'PRODUCTION' depending on your use case
  environment: 'SANDBOX',
}

// This will initialize the Kanmon Connect Web SDK
KANMON_CONNECT.start(config)

Opening the Embedded UI Component

When a user interacts with your application and you want to open the embedded Kanmon UI, you can do so by calling the show method.

import { KANMON_CONNECT } from '@kanmon/web-sdk'

// This will open the Kanmon Connect iframe
KANMON_CONNECT.show()

Want more indepth examples?

Check out our full documentation on the Kanmon Web SDK and the rest of our integration options on our official docs.

Versioning

Kanmon's spin on Semver

• Major version changes - non-backwards compatible API or SDK changes.
• Minor version changes - API changed, but backwards compatible. (SDK will change because of this too)
• Patch version changes - SDK bug fixes without syntax changes.

Our API docs located at https://kanmon.dev will always be up to date with the latest minor version. Patches won't be reflected in the API docs. Example: v2.1.

SDK tracks all the way to patches. v2.1.3 -> v2.1.4 would update the SDK package but the README docs wouldn't have changed.

Support

If you have any issues, please report them to your account manager and we'll be happy to help you directly!