补课:v0.10.0 SDK发布npm

发布于 2025-09-26

大家好:

我终于来把 0.10.0 发布时欠的 SDK 补上了,Typescript 版本已经正式发布到 npm 上。官方门户也是使用该接口,保障完全兼容,而且能够调用所有功能,便于定制开发和集成。

地址www.npmjs.com/package/@taiyi-io/api-connector-ts,可以在你的项目里使用以下指令安装

$ npm install @taiyi-io/api-connector-ts
或者
$ yarn add @taiyi-io/api-connector-ts

核心类是 TaiyiConnnector,也提供了两个辅助函数 newInsecureConnector 和 getNextConnector 获取封装好的 Connector 实例。

但是基于数据安全原因,依然建议根据自己业务场景封装自己的 connector。

connector 可以使用密码或者连接字符串校验,连接字符串通过管理门户的账号管理>访问令牌获取。校验通过后即可访问平台全部功能。

使用非常简单,以查询云主机为例:

const deviceID = "test-device";
const connector = await newInsecureConnector(
  deviceID,
  process.env.ACCESS_STRING!, //连接字符串
  process.env.BACKEND_HOST!,
  Number(process.env.BACKEND_PORT)
);

//从第13个记录开始,查询10条记录
const result = await connector.queryGuests(13, 10);
if (result.error) {
  throw new Error(result.error);
}
//PaginationResult
const data = result.data;
console.log(
  "返回结果 %s, 总记录数 %d",
  JSON.stringify(data.records),
  data.total
);

更详细请访问 API 文档:api.taiyi.io

补了课,后续将开始 v0.11.0 的设计了

敬请期待

Akumas

如有意见建议或者咨询,欢迎扫描加入 QQ 群:933372811

qq
qq