⚡ A local-first REST client for Oracle CPQ, available directly from VS Code. Search the documented API catalog, build a request for a real CPQ environment, and inspect the response in your browser.
🚀 Start here
- Open VS Code and press
Ctrl+Shift+X to open Extensions.
- Search for Oracle CPQ API Studio and install the extension.
- Select Oracle CPQ API Studio in the Activity Bar, then choose Open API Studio to start the local server and open the REST client in your browser.
- No separate Node.js, npm, or API-client account is required.
🤔 Why this exists
Oracle CPQ API work often means searching documentation, assembling requests by
hand, switching between environments, and inspecting large responses across
multiple tools.
API Studio brings that workflow into one local-first REST client built specifically around the documented Oracle CPQ API catalog.
🛠 What you can do
|
|
| 🔎 Find the right endpoint |
Search and browse 962 Oracle CPQ REST APIs by area, section, method, or version. |
| 📖 Start with context |
Use documented paths, parameters, sample bodies, response details, and source documentation. |
| 🌐 Work across environments |
Save CPQ site URLs, variables, versions, and credentials for the systems you work with every day. |
| 🔐 Authenticate confidently |
Send requests with Basic, Bearer, or no auth, including per-request overrides. |
| 📦 Make results useful |
Save requests, organize folders, favorite endpoints, import/export cURL, and review local history. |
| 📊 Read large responses |
Explore a responsive JSON tree, open a formatted full response, save it, or compare two responses locally. |
| ⇄ Compare responses locally |
Use Diff Checker to format JSON, view side-by-side or unified diffs, and fold unchanged lines without uploading or saving the comparison. |
🔗 More extensions
- Developer Tools for CPQ adds BML autocomplete, inline validation, quick fixes, BMQL support, formatting, and offline Oracle BML documentation directly in VS Code.
- Request Logger captures POST request bodies through temporary public URLs and lets you inspect them in a private local dashboard.
You can also find both by name in the VS Code Extensions view (Ctrl+Shift+X).
📨 Your first request
- Open Oracle CPQ API Studio from the Activity Bar.
- Create a passphrase to protect saved site passwords on this machine.
- Search or browse the catalog, then open an endpoint.
- Add an environment if you want reusable site details, variables, or credentials. You can also fill in a one-off request directly.
- Complete the request and select Send.
- Inspect the response as a tree, raw payload, or headers. Save it or compare it when that helps.
Requests support JSON, XML, plain text, form data, URL-encoded data, and file
bodies. Every response shows its status, duration, size, headers, and body.
🔒 Local by design
Your data stays close to home
API Studio keeps your saved environments, credentials, requests, and history on
your machine. The only remote destination is the CPQ site you explicitly
choose when you select Send.
| Promise |
How API Studio keeps it |
| No telemetry |
No usage analytics, hosted workspace, credential collection, request data, or response data. |
| Local server |
The Studio server binds to 127.0.0.1 and is not exposed to your network. |
| Visible lifecycle |
VS Code shows the local URL while the server starts and runs, with a Copy URL action in the ready notification. |
| Safe multi-window use |
Additional VS Code windows reuse the running Studio. The owner window controls Stop API Studio. |
| Extension storage |
Environments, variables, saved requests, favorites, notes, tabs, and history live in VS Code extension storage, not your project folder. |
| Protected passwords |
Saved site passwords use AES-256-GCM encryption. Your passphrase is never stored or transmitted. |
| Safe request defaults |
TLS verification stays enabled, redirects are not followed, and DELETE requests require confirmation. |
⚠ History, saved work, and exported files can contain client data. Treat
them with the same care as any other local development artifact.
📁 Where local data is stored
The packaged extension uses VS Code's per-extension global storage folder. It
does not write this data into the open project or to a cloud account.
| Platform |
Typical folder |
| Windows |
%APPDATA%\Code\User\globalStorage\YashwanthKumar.oracle-cpq-api-studio\ |
| macOS |
~/Library/Application Support/Code/User/globalStorage/YashwanthKumar.oracle-cpq-api-studio/ |
| Linux |
~/.config/Code/User/globalStorage/YashwanthKumar.oracle-cpq-api-studio/ |
The exact path is also shown in the API Studio sidebar. VS Code profiles,
Insiders, and Extension Development Host sessions can use a separate storage
location.
⚠ Need a clean start? In the sidebar, expand Local data storage
and choose ⚠ Erase all local data. After a confirmation, it
permanently deletes API Studio environments and variables, saved requests,
folders and notes, history, open tabs, favorites, and encrypted site
passwords. It does not uninstall the extension or remove the built-in API
catalog. This cannot be undone.
🏢 Ready for enterprise networks
API Studio uses your operating-system proxy settings, including PAC files, and
the system trust store for corporate TLS inspection. This lets it work with
common VPN, proxy, and trusted-certificate setups without changing the normal
request workflow.
💬 Questions or problems?
⭐ If you find this useful, a review on the Marketplace helps other CPQ developers find it.
Made for Oracle CPQ developers, by an Oracle CPQ developer.
Not an official Oracle product. Oracle and CPQ are trademarks of Oracle Corporation.
| |
