WEDA Postman API Collection
Download WEDA Postman API Collection
What is WEDA Postman API Collection?
This Postman collection provides ready-to-use API requests for the WEDA platform. Instead of manually constructing API calls, you can use these pre-configured requests to quickly test and integrate WEDA APIs.
What's Included:
- ✅ Authentication & Authorization
- ✅ Organization & Device Management
- ✅ Container Stack Deployment
- ✅ Telemetry Data Collection
- ✅ Tunnel Management for Remote Access
Why Use This Collection?
Problems It Solves
1. Complex API Dependencies
WEDA APIs require specific execution sequences (e.g., authenticate → create org → provision device). This collection handles the sequence automatically.
2. Manual Testing is Tedious
Testing APIs manually requires remembering URLs, parameters, and authentication tokens. This collection automates these tasks.
3. Multi-Module Coordination
Testing end-to-end workflows (e.g., deploy container to device) requires coordinating multiple API calls. This collection chains requests together.
4. Learning Curve
Understanding how to use WEDA APIs can be challenging. This collection provides working examples you can run immediately.
What You Get
✅ Pre-configured Requests - All API calls ready to use
✅ Automatic Variable Management - Authentication tokens and IDs are auto-saved between requests
✅ Sequential Workflows - Requests automatically chain together for complex operations
✅ Built-in Validation - Each request includes test scripts to verify success
Pre-requisites
Step 1: Install Postman
Step 2: Get Collection Files
Download and extract the WEDA API collection package
Note: If you download the .zip file, make sure to extract it.
Step 3: Import into Postman
- Click Import button (top-left)
- Choose the file or folder you downloaded
- Click Import, You should see 6 collections imported in the left sidebar
Postman Overview
- left side:
- Collections: 6 collections containing categorized API requests
- Environments: Select
weda-coreenvironment for API requests
- main panel:
- send request and request setting/response details
- right side:
- Variables: shows environment variables (auto-populated from API responses)
Step 4: Configure Your Environment
- Click Environments tab (left sidebar)
- Select your environment(
weda-core). - Update these 4 required variables:
| Variable | Your Value |
|---|---|
login | <your-login-id> |
password | <your-password> |
idsbaseurl | https://tpe.cloud.advantech.com/central/weda |
apibaseurl | https://tpe.cloud.advantech.com/central/weda/api/v1 |
Note: If you don't have WEDA account, please go to Register Free Trial to request one.
You don't need to manually check these variables except for the 4 variables mentioned above - they are automatically captured from API responses.
- Activate the environment - Select it from the dropdown (top-right corner)
Congratulations! You're ready to use the WEDA API collection.
How to Use
Running a Single Request
- Select a collection from the left sidebar (e.g., 2-Provisioning&Activation)
- Click on a request (e.g., Provisioning Node)
- Review the request details in the main panel
- Click Send button
- Check the response:
- Status code (should be 200, 201, or 202 for success)
- Response body (JSON data returned by API)
- Test Results tab (validation results)
despite the detail of each API, the most important thing when using WEDA Postman API collection is to use the API in sequential workflows. Please follow the squence of collections to run the APIs, and you can achieve the desired results.
Troubleshooting
Clear All Cookies
Goal: Before starting, it's recommended to clear all cookies in Postman to avoid authentication issues. And if you get any error with unknown reason, please try to clear cookies and run again.