Quick Start
The official SDK and Bruno collection are published at github.com/svnwi/wlte-openapi-sdk.
The repository includes:
- A Bruno collection for interactive API testing without writing code.
- TypeScript, Python, and Go SDKs that wrap authentication, error handling, and common device APIs.
Bruno Quickstart
Bruno is a file-based API client. Requests, environment variables, and test assertions are stored as plain text files and can be versioned in Git.
Install Bruno
Desktop app (recommended for beginners)
Download from usebruno.com.
CLI (for CI / headless environments)
npm install -g @usebruno/cliVerify the installation:
bru --versionGet the Collection
Clone or download the SDK repository:
git clone https://github.com/svnwi/wlte-openapi-sdk.gitThe Bruno collection is located at:
examples/bruno/WLTE-OpenAPI/Open this folder as a collection in the Bruno desktop app.
Configure Environment Variables
- Open
environments/quickstart.bru. - Replace only the following two values with your credentials:
clientId → your_client_id
clientSecret → your_client_secretAll other variables (accessToken, deviceId, commandId) are populated automatically by the collection scripts as you run requests. You do not need to set them manually.
relayIndex is preset to 1. Change it only if you want to target a different relay channel.
- In the Bruno desktop app, select the quickstart environment from the environment selector.
Recommended First Path
Run the requests in this order:
| Step | Request |
|---|---|
| 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 |
Each request includes built-in assertions. A green result means the response passed both the HTTP status check and payload-shape validation.
What the Collection Covers
| Folder | Requests |
|---|---|
00-auth | Get access token |
01-device-queries | List devices, real-time status, device profiles |
02-relay-control | Turn relay on, turn relay off, jog relay |
03-command-result | Query command execution result |
CLI Usage
If you prefer the command line:
cd examples/bruno/WLTE-OpenAPI
bru run --env quickstartSDK Integration
The SDKs are currently distributed as repository source code. They do not depend on public npm, PyPI, or other package registries yet.
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-profilesPython
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.pyGo
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_profilesCurrent SDK coverage: automatic access-token retrieval, device listing, device details, device type definitions, relay control, and command result lookup.
Test Access
You do not need to purchase hardware to experience the API or test against different device models.
Contact support@svnwi.com to request a test API key and learn what demo device coverage is available.
Related Documentation
- REST API Overview: Review HTTP endpoints, authentication, request rules, and endpoint coverage.
- WebSocket / WSS Overview: Review WSS connections, message format, real-time requests, and device events.
- API Clients and Credentials: Create API clients, assign scopes, and manage secrets.
