@ding-live/sdk
v2.0.0
Published
The official Ding SDK
Downloads
9,420
Readme
Ding Javascript SDK
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 [email protected] 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);