Before You Start
Download & Import
Download the WEDA Postman API Collection from the Learning Hub:
After downloading and extracting the ZIP:
- Open Postman and click Import (top-left)
- Select the extracted folder
- Click Import
You should see 7 collections and 1 environment (weda-core) appear in the left sidebar.
Configure the Environment
- Click Environments in the left sidebar
- Select weda-core
- Fill in your account credentials:
| Variable | Value | Notes |
|---|---|---|
login | Your WEDA account email | Required — you must fill this in |
password | Your WEDA account password | Required — you must fill this in |
domain | https://{your-weda-domain} | Pre-filled with https://tpe.cloud.advantech.com; change only if your deployment differs |
ssoBaseUrl | identity | Pre-filled; change only if your deployment differs |
- Click Save, then activate the environment from the dropdown in the top-right corner
tenantPath defaults to central and appPath defaults to weda. You do not need to change these unless your deployment uses different values. All other variables are filled in automatically by Postman scripts as you run each collection.
Run Collections in Order
Collection 0 (SSO login) relies on browser cookies. If you have an existing session or encounter unexpected login errors, clear your Postman cookies first before starting — otherwise the login flow may silently reuse a stale session and produce incorrect tokens.
To clear cookies: go to Settings → Cookies and delete all cookies for your domain, then re-run from Collection 0.
Collections 0 → 1 → 2 must run in that order — each builds on the variables set by the previous one. After Collection 2, collections 3, 4, 5, and 7 are independent and can be run in any order.
Do not skip collections. If a required variable is missing, requests in a later collection will fail with authentication or not-found errors.
How to Read These Guides
Each tutorial article corresponds to one collection. The article number matches the collection number.
Every request entry follows this format:
- API — link to the API reference (omitted for internal steps with no public endpoint)
- Script — what Postman handles automatically (variable capture, cookie management, polling, etc.)
- Result — the HTTP status and response you should see
Some requests are polling loops — Postman's test script re-sends the request automatically until a target status is reached. These steps include an Automatic polling tip in their description. When you run one, send it once and wait; do not keep clicking Send manually.
Tip: Clearing Cookies
If you encounter unexpected authentication errors, clear Postman's cookies and re-run Collection 0 from the beginning.
To clear cookies: go to Settings → Cookies and delete all cookies for your domain.
The first request in Collection 0 (External Login 302) includes a pre-request script that clears cookies automatically. However, manually clearing cookies before starting is the safest approach, especially if a previous session was interrupted.