Node.js 集成文档

最近更新时间:2023-07-14 17:31:43 前往 Coding 编辑

导出文档

一、准备环境

  1. 使用 SDK 需要您的运行环境包含 nodejs 以及 npm,其中 nodejs 版本要求 ≥ 10.0.0。
  2. 注册登录 新联云管理中心控制台
  3. 前往 云API密钥 的控制台页面,获取或创建您的项目 SecretId 和 SecretKey。
说明:

SecretId 和 SecretKey 必须严格保管,避免泄露。

二、获取安装

通过 Npm 安装

通过 npm 获取安装是使用 NODEJS SDK 的推荐方法,npm 是 NODEJS 的包管理工具。关于 npm 详细可参考npm 官网

  1. 执行以下安装命令:
    npm install @neunit/cloud-sdk-nodejs --save
  2. 在您的代码中引用对应模块代码,可参考示例。

通过源码包安装

  1. 前往 Coding 仓库 下载源码。
  2. 将源码包中的 xlcloud 文件夹放到您项目合适的位置。
  3. 在您的代码中引用对应模块代码,可参考示例。

三、示例

const xlcloud = require("@neunit/cloud-sdk-nodejs")
// 导入对应产品模块的client models。
const TtsClient = xlcloud.tts.v1.Client;

// 实例化要请求产品(以tts为例)的client对象
const client = new TtsClient({
  credential: {
    secretId: 'secretId',
    secretKey: 'secretKey',
  },
})

// 通过client对象调用想要访问的接口,需要传入请求对象(Params)以及响应回调函数
// 基础语音合成
client.textToVoice({
  text: '',
  session_id: '',
}, function (err, response) {
  // 请求异常返回,打印异常信息
  if (err) {
    console.log(err);
    return;
  }
  // 请求正常返回,打印response对象
  console.log(response);
});

在支持 typescript 项目中,采用如下方式调用

import * as xlcloud from "@neunit/cloud-sdk-nodejs"

const TtsClient = xlcloud.tts.v1.Client

// ...

四、相关文档