Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
/ ding-node Public archive

Ding SDK for Node.JS, with native Typescript support

License

Notifications You must be signed in to change notification settings

ding-live/ding-node

Repository files navigation

Ding Javascript SDK

Warning

This SDK is deprecated in favor of the Ding Typescript SDK.

Version

The Ding Javascript SDK allows Javascript backends to access the Ding API programmatically.

Requirements

Node 12 or higher.

Installation

Install the package with:

npm install @ding-live/sdk --save
# or
yarn add @ding-live/sdk

Usage

The package needs to be configured with your account's UUID and your secret key. Ping hello@ding.live to get them.

import ding, { DeviceType } from "@ding-live/sdk";
const client = new Ding("<CUSTOMER_UUID>", "<SECRET_TOKEN>");

// Authenticate
const auth = await client.authenticate("+12065550100");

// Check the code the user entered
const check = await client.check(auth.uuid, "1234");

// Retry the auth
const retry = await client.retry(auth.uuid);

More options

// Authenticate with metadata to increase spam detection
client
  .authenticate("+12065550100", {
    ip: "192.168.0.1",
    deviceId: "asd8789asf76a98sdf6sdf7s7d8",
    deviceType: DeviceType.Ios,
    appVersion: "1.0",
    callbackUrl: "<YOUR_CALLBACK_URL>",
  })
  .then(console.debug);