npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xendit-fingerprint-sdk-web

v1.1.1

Published

Web SDK for Xendit's device fingerprinting.

Downloads

12

Readme

Xendit Fingerprint SDK Web

Web SDK for device identification and fingerprinting with Xendit services.

Basic Usage

Initialize the SDK with your public API key on application start up and perform a scan.

The SDK must be initialized before use.

// Initialize the SDK on every page load
XenditFingerprintSDK.init({
  apiKey: 'MY_PUBLIC_API_KEY',
})
// Run a scan immediately after initialization
XenditFingerprintSDK.scan()

The session ID is retrievable from either XenditFingerprintSDK.init() on SDK initialization or from the XenditFingerprintSDK.getSessionID() convenience method any time after initialization.

Both of these functions returns a Session ID of type string.

// On SDK init
var sessionID = XenditFingerprintSDK.init('MY_PUBLIC_API_KEY')

// After SDK init
var sessionID = XenditFingerprintSDK.getSessionID()

This Session ID can then be passed on to other Xendit APIs that support device fingerprinting. Please refer to the respective API's documentation for further info.

Requirements

Supported web browsers:

  • Chrome 49+
  • Firefox 52+
  • Edge 93+
  • Desktop Safari 12.1+
  • Mobile Safari 10.3+
  • Samsung Internet 14.0+
  • Android Browser 4.4+

Installation

In a browser:

<script src="https://cdn.jsdelivr.net/npm/xendit-fingerprint-sdk-web/dist/xendit-fingerprint-sdk-web.js">

Using NPM:

$ npm install --save xendit-fingerprint-sdk-web

Methods

Asynchronous SDK methods have been labeled async, these return a Promise object. Refer to the returns section of each method for the resolved type.

init()

The SDK must be initialized before it can be used.

  • Initialization must be ran on every web page load.
  • The SDK will associate a session ID for the webpage until it's closed.
  • A new session ID will be assigned on every page load.
  • Single page apps (SPAs) will have the same session ID if JS based routing is used. Because the web page is only loaded once.
const sessionId = XenditFingerprintSDK.init({apiKey: publicKey});

Parameters

| Name | Type | Required | Description | | ----------- | ------------------ | -------- | ---------------------- | | initOptions | InitOptions Object | Yes | Initialization options |

Do not use your private API key!

InitOptions Object

| Name | Type | Required | Description | | ------ | ------ | -------- | ----------------------------------------------------------------------------------- | | apiKey | string | Yes | A valid public API key provided by Xendit Dashboard |

Returns

| Name | Type | Description | | --------- | ------ | -------------------- | | sessionId | string | Generated session ID |

async scan()

Scans the web browser and sends the device fingerprint data to Xendit.

  • Scan should be called immediately after initializing the SDK.
  • Scan can be called multiple times within a session.
  • Do not await the scan, let it run in the background. This avoids blocking any foreground application code execution.
XenditFingerprintSDK.scan()
// Or
XenditFingerprintSDK.scan(customerEventName, customerEventID)

Parameters

| Name | Type | Required | Description | | ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------- | | customerEventName | string | No | Optional event name to associate with this scan. Recommended to use snake case formatting. e.g. 'some_event_name' | | customerEventID | string | No | Optional identifier associated with the event. e.g. user account ID |

getSessionID()

Convenience method to retrieve Session ID after SDK initialization.

const sessionId = XenditFingerprintSDK.getSessionID();

Returns

| Name | Type | Description | | --------- | ------ | -------------------- | | sessionID | string | Generated session ID |

setEnabled()

Enables or disables the SDK.

  • When disabled, the scan method will do nothing. No data will be sent to Xendit.
  • When enabled, the SDK will resume operating as normal.
  • The SDK can be disabled before initializing.
// Disables the SDK
XenditFingerprintSDK.setEnabled(false);
// Re-enables the SDK
XenditFingerprintSDK.setEnabled(true);

Parameters

| Name | Type | Required | Description | | ------ | ------- | -------- | ---------------------------------------------------- | | enable | boolean | Yes | true enables the SDK.false disables the SDK. |