Dingyue

Appearance

安装 ​

要将DingYue WEB SDK集成到您的项目中，可以进行如下操作

通过 npm 安装 ​

首先在项目目录中运行：

bash
npm install dingyue-web-sdk
# 或
yarn add dingyue-web-sdk

初始化 ​

方式一：使用构造函数（推荐） ​

javascript
import DingYueSDK from 'dingyue-web-sdk';

const sdk = new DingYueSDK({
  baseUrl: 'https://mobile.dingyue.io',  // API 服务地址（必填）
  appId: 'your-app-id',                    // 应用 ID（必填）
  apiKey: 'your-api-key',                 // API 密钥（必填）
  sdkVersion: '1.0.0',                    // SDK 版本（可选，默认使用当前版本）
  storageName: 'dingyue_token'            // 本地存储键名（可选，默认 'dingyue_token'）
});

方式二：使用静态方法 init（单例模式） ​

javascript
import DingYueSDK from 'dingyue-web-sdk';

// 初始化全局配置
DingYueSDK.init({
  baseUrl: 'https://mobile.dingyue.io',
  appId: 'your-app-id',
  apiKey: 'your-api-key',
  sdkVersion: '1.0.0',
  storageName: 'dingyue_token'
});

// 获取单例实例
const sdk = DingYueSDK.getInstance();

配置参数说明 ​

参数类型必填说明
baseUrlstring是API 服务地址（与 apiUrl 二选一，推荐使用 baseUrl）
apiUrlstring是*API 服务地址（已废弃，建议使用 baseUrl）
appIdstring是应用 ID
apiKeystring是API 密钥
sdkVersionstring否SDK 版本号，默认使用当前 SDK 版本
storageNamestring否本地存储键名，默认 'dingyue_token'

在 Vue 项目中使用 ​

javascript
// main.js
import DingYueSDK from 'dingyue-web-sdk';

const sdk = new DingYueSDK({
  baseUrl: process.env.VUE_APP_API_URL || 'https://mobile.dingyue.io',
  appId: process.env.VUE_APP_APP_ID,
  apiKey: process.env.VUE_APP_API_KEY
});

// 挂载到 Vue 实例
Vue.prototype.$sdk = sdk;

在 React 项目中使用 ​

javascript
// sdk.js
import DingYueSDK from 'dingyue-web-sdk';

export const sdk = new DingYueSDK({
  baseUrl: process.env.REACT_APP_API_URL || 'https://mobile.dingyue.io',
  appId: process.env.REACT_APP_APP_ID,
  apiKey: process.env.REACT_APP_API_KEY
});

Copyright © 2025 Dingyue