API Explorer
A fully-featured, Postman-grade HTTP client embedded directly inside your Vispane workspace. Craft, send, and debug API requests without ever switching tabs.
What is the API Explorer?
The API Explorer is the cornerstone tool of the Vispane backend suite. It replicates the full functionality of dedicated API clients (like Postman or Insomnia) but eliminates the context-switching penalty by running inline alongside your live UI preview. You can see the exact effect of an API call on your frontend the moment the response arrives, with zero switching.
It is cloud-synced through Team Workspaces, meaning your entire team shares the same collection of requests, environments, and history automatically. It is not just a personal tool—it's a shared source of truth for your entire API surface.
Team Workspaces
Owner / Editor / Viewer roles with cloud-synced Collections and History across your entire team.
Advanced Authentication
Supports Bearer Tokens, Basic Auth, API Keys (header or query), and full OAuth 2.0 auto-fetch flows.
CORS Proxy
Built-in server-side proxy that bypasses browser CORS restrictions on any endpoint.
WebSocket Support
Connect to real-time endpoints, monitor bidirectional message streams live.
Import & Export
Import Postman v2.1 collections or raw cURL commands. Export any request back as cURL.
Error Advisor
Contextual, actionable advice for every HTTP error code (400, 401, 403, 422, 500…).
Complete Request Configuration
Every request is composed using a rich multi-tab editor. Nothing is hidden or hard to reach.
- Params tab: Manage URL query parameters as key-value pairs. Enabled/disabled individually without deletion.
- Auth tab: Configure None, Bearer, Basic, API Key, or OAuth 2.0. OAuth 2.0 includes an auto-fetch token button powered by a full client credentials flow.
- Headers tab: Add custom headers with toggle switches, identical to the params experience.
- Body tab: Supports raw JSON (with syntax highlighting), URL-encoded form data, and multipart/form-data with file uploads.
- Scripts tab (Pre-Request): Write pre-request scripts to dynamically modify the request before sending.
- Tests tab: Define assertions (e.g.,
status === 200) to validate responses automatically. - Notes tab: Attach markdown notes to any saved request for team documentation.
How to Send Your First Request
- 1
Open the API Explorer panel
Click the rocket icon in the left rail of the Vispane preview. The panel opens in a draggable, resizable overlay.
- 2
Select your HTTP method
Use the method dropdown to select GET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS.
- 3
Enter the endpoint URL
Type or paste the URL. Use environment variables for dynamic values:
/api/v1/users. The variable will resolve based on your active Environment Switcher configuration. - 4
Configure authentication
Open the Auth tab and select your type. For JWT routes, use the Auth Token Manager and click "Inject into API Explorer" to auto-populate the Authorization header.
- 5
Add a request body (if applicable)
For POST/PUT/PATCH, switch to the Body tab, set type to JSON, and enter your payload in the syntax-highlighting editor.
- 6
Send the request and analyze the response
Hit Send. The response panel shows the status code, latency, raw/pretty-printed JSON, response headers, and if any assertion test failed.
- 7
Save to a Collection
Click the Save icon and choose a workspace collection. The request is immediately available to all editors on your team.
Best Practices for Power Users
Never hardcode URLs in your requests. Use the Environment Switcher to define a base_url variable so you can switch between local, staging, and production with a single click—without touching any individual request.Common Issues & Fixes
- Request fails instantly (Status 0 / Network Error): The browser blocked it due to CORS. Enable the server-side proxy toggle in the Explorer toolbar.
- 401 Unauthorized on a route you know has a valid token: Check the token's expiry badge in the Auth Token Manager. JWT tokens silently expire. Regenerate and re-inject.
- 404 Not Found on a valid endpoint: Ensure your active environment's
base_urlis correctly set. A common mistake is keeping the Dev environment active while testing a route that only exists on Staging. - Team collection not syncing: Confirm you are in a shared Workspace (not Personal). Collections in the Personal workspace are local-only and not cloud-synced.