Postman Collection

WisPanel ships two Postman collections (schema v2.1.0). Import the one for the API you target.

Both ship in the SDK bundle alongside the PHP SDK.

WisPanel API v1 — structure (verified)

17 folders, 123 requests:

00 - Authentication (13)      09 - File Manager (10)
01 - Session & Audit (4)      10 - Cron Jobs (4)
02 - Users & Resellers (14)   11 - Backup & Restore (5)
03 - Domains (13)             12 - WordPress (4)
04 - DNS (6)                  13 - Security (9)
05 - SSL Certificates (5)     14 - System & Services (12)
06 - Databases (5)            15 - Webhooks (5)
07 - Email (7)                16 - SSO (Cross-System Login) (4)
08 - FTP (3)

Variables: base_url, token, username (default john), domain (default example.com), sso_nonce.

Setup

1. Postman → File → Import → drop wispanel-api.postman_collection.json.
2. Collection → Variables tab:
   • base_url → your panel, e.g. https://panel.example.com:3082
   • token → a full API key, e.g. wsp_6837c3a0ccf3feb8137516b425aef16bccf85254d76d2d39
   • username / domain → values the :username / :domain path params use.
3. Auth is set at the collection root (Bearer {{token}}); every request inherits it. Public ones (login, /sso/consume, /sso/exchange) override to No Auth.

The key's permission scope is enforced (see Authentication). For the full collection to work the key needs all; a narrowly scoped key returns 403 "API key is not scoped for '<resource>' on this request".

Verified working example

GET {{base_url}}/api/v1/auth/me with the variables set returns 200 (live-tested):

{ "username": "admin", "email": "[email protected]",
  "role": "admin", "status": "active", "package": "default" }

WisPanel Internal Admin API — structure (verified)

6 folders, 27 requests: Posts (5), Pages (5), Features (5), FAQs (5), Releases — Upsert + File Upload (4), Auth / Error samples (3).

Variables: base_url (default https://wispanel.com), api_key, post_id, page_id, feature_id, faq_id, release_id.

Setup

1. Import wispanel-internal-admin-api.postman_collection.json.
2. Variables: base_url (prod https://wispanel.com) and api_key (your portal ADMIN_API_KEY — set per-environment, never commit).
3. Auth is the collection-level header X-Admin-Key: {{api_key}}.

Verified live: GET {{base_url}}/api/v1/admin/pages?type=api_doc returns 200 with the docs pages.

Idempotency-Key

Add an Idempotency-Key: {{$guid}} header on POST/PUT/PATCH/DELETE requests to make retries safe (Postman's {{$guid}} generates a fresh UUID). Replay semantics and the 409 IDEMPOTENCY_KEY_CONFLICT → see Webhooks, Idempotency & OpenAPI.

Codegen / OpenAPI

GET /openapi.yaml (no auth) returns the OpenAPI 3.0 spec — import it into Postman or any client generator instead of hand-mapping requests.

Issue an API key → Authentication. Error envelopes → Error Handling.