本文档旨在指导 Node.js 开发者如何快速地将视频点播服务端 SDK 集成到您的项目中,并完成客户端的初始化。
Node.js 12.0.0 或更高版本。
视频点播 Node.js SDK 通过 npm 或 yarn 进行管理。请在您的项目根目录下,执行以下任一命令来安装 SDK。
说明
yarn upgrade @volcengine/openapi@latest。# 使用 npm 安装 # 命令中的 --save 会将模块写入应用的 package.json 文件中,作为依赖模块。 npm install @volcengine/openapi --save # 或者使用 yarn yarn add @volcengine/openapi
为了让 SDK 能够验证您的身份并发起 API 调用,您需要配置访问密钥(Access Key)。
说明
在火山引擎控制台的密钥管理页面创建并获取 AK 和 SK。
此方式将敏感信息与代码解耦,提升了安全性。您只需在运行程序的服务器环境中设置以下两个环境变量即可,SDK 会自动读取。
export VOLC_ACCESSKEY="Your_AK" export VOLC_SECRETKEY="Your_SK"
您可以在用户主目录(~)下创建一个 .volc/config 文件,并按以下 JSON 格式填入您的 AK 和 SK。SDK 会自动从此路径加载凭证。
{ "ak":"Your_AK", "sk":"Your_SK" }
在某些临时测试或特殊场景下,您也可以在代码中直接设置 AK 和 SK。
警告
安全警告:此方式存在敏感信息硬编码在代码中的风险。请不要在生产环境的代码中直接包含 AK 和 SK,以防源码泄露导致密钥丢失。
import { vodOpenapi }from'@volcengine/openapi'; // 使用默认的service实例。你也可以创建一个新实例。 // const vodOpenapiService = new vodOpenapi.VodService(); const vodOpenapiService = vodOpenapi.defaultService; // 设置 ak/sk vodOpenapiService.setAccessKeyId(AccessKeyId); vodOpenapiService.setSecretKey(SecretKey); // 如果使用sts进行请求,设置完成ak/sk之后还需要设置一下SessionToken vodOpenapiService.setSessionToken(SessionToken);
完成 SDK 安装和凭证配置后,您就可以初始化视频点播服务的客户端实例 VodService 了。Node.js SDK 当前仅支持创建使用默认地域(华北1 cn-north-1)的实例。
import { vodOpenapi } from '@volcengine/openapi'; // 如果您已通过环境变量或配置文件设置 AK/SK,则无需再调用 setAccessKeyId/setSecretKey const vodOpenapiService = vodOpenapi.defaultService;
获取到 vodOpenapiService 实例后,您就可以调用其下的方法来发起 API 请求了。不同功能模块的接口调用示例,请参见以下文档: