快速开始

官方 SDK 及 Bruno 集合已发布至 github.com/svnwi/wlte-openapi-sdk。

仓库包含：

• Bruno 集合，无需编写代码即可进行交互式 API 测试。
• TypeScript、Python、Go SDK，封装认证、错误处理和常用设备接口。

Bruno 快速入门

Bruno 是一款基于文件的 API 客户端。请求、环境变量和断言以纯文本文件形式存储，可直接纳入 Git 版本管理。

安装 Bruno

桌面应用（推荐新手使用）

从 usebruno.com 下载安装。

命令行（适用于 CI / 无界面环境）

npm install -g @usebruno/cli

验证安装：

bru --version

获取集合

克隆或下载 SDK 仓库：

git clone https://github.com/svnwi/wlte-openapi-sdk.git

Bruno 集合位于：

examples/bruno/WLTE-OpenAPI/

在 Bruno 桌面应用中将该文件夹作为集合打开。

配置环境变量

1. 打开 environments/quickstart.bru。
2. 仅替换以下两个值为你的凭据：

clientId     →  your_client_id
clientSecret →  your_client_secret

其余变量（accessToken、deviceId、commandId）会由集合脚本在你运行请求时自动填充，无需手动设置。

relayIndex 默认为 1，如需控制其他继电器通道，修改该值即可。

3. 在 Bruno 桌面应用的环境选择器中，选择 quickstart 环境。

推荐调用顺序

按以下顺序运行请求：

步骤	请求
1	00-auth / Auth
2	01-device-queries / 01-list-devices
3	01-device-queries / 02-get-device-real-time-status
4	02-relay-control / 01-turn-relay-on
5	03-command-result / 01-get-command-result

每个请求内置断言。绿色结果表示响应通过了 HTTP 状态码校验和响应体结构验证。

集合内容概览

文件夹	请求
00-auth	获取访问令牌
01-device-queries	设备列表、实时状态、设备配置
02-relay-control	继电器开、继电器关、点动控制
03-command-result	查询命令执行结果

命令行使用

如果你偏好命令行方式：

cd examples/bruno/WLTE-OpenAPI
bru run --env quickstart

SDK 接入

当前 SDK 以仓库源码方式提供，暂不依赖公开 npm、PyPI 等包注册表。

TypeScript

git clone https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk/sdk/typescript
cp .env.example .env
npm install
npm run example:list-devices
npm run example:list-profiles

Python

git clone https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk
cp sdk/python/.env.example sdk/python/.env
python3 sdk/python/examples/list_devices.py
python3 sdk/python/examples/list_profiles.py

Go

git clone https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk/sdk/go
cp .env.example .env
go run ./examples/list_devices
go run ./examples/list_profiles

SDK 当前覆盖：自动获取 access token、设备列表、设备详情、设备类型定义、继电器控制、命令结果查询。

测试访问

无需购买硬件即可体验 API 或针对不同设备型号进行测试。

请联系 support@svnwi.com 申请测试 API Key，并了解当前可用的演示设备覆盖范围。

相关文档

• REST API 总览：查看 HTTP 接口、认证方式、请求规则和端点列表。
• WebSocket / WSS 总览：查看 WSS 连接、消息格式、实时请求和设备事件。
• API Client 与凭证：创建 API Client、配置权限范围并管理密钥。