API contracts
Use these files for code generation, validation, and contract review.
Tools and examples
Every runnable package demonstrates the same server-side authentication, JWT retry, prepared request, API error handling, and result workflow. Choose your application language, or start with the visual browser sample. Credentials are never embedded in browser JavaScript.
- Download the .NET reference clientZIP source package
- Download the client and runnable sampleZIP source package
- Node.js runnable sampleNode.js 18+, no packages
- Python runnable samplePython 3.9+, standard library
- Go runnable sampleGo 1.21+, standard library
- Java runnable sampleJava 11+, standard library
- PHP runnable samplePHP 8.1+ with cURL
- Self-contained Windows visual sampleWindows x64; no runtime installation
- Windows visual sample sourceASP.NET Core 8 source
- Visual browser sampleNode.js server and editable web UI
- Postman collectionImportable collection
- Postman environmentCredential placeholders
- Prepared decision requestExample JSON
- Business-data requestExample JSON
- Invalid request test caseExample JSON
How to use the samples
Download and extract the package for your language. Set DECISIOQ_CLIENT_ID and DECISIOQ_CLIENT_SECRET as environment variables before running it. Each command-line sample reads the included prepared decision request, obtains a JWT from VINquery Identity, calls DecisioQ, retries authentication once after a 401 response, and prints the result.
C# / .NET 8
Reference client: decisioq-dotnet-client-7.6.3.zip is reusable C# source for an existing application. It wraps authentication, HTTP calls, correlation IDs, response models, and API errors. It is a class library and is not started by itself.
Runnable sample: decisioq-dotnet-sample-7.6.3.zip includes that client plus a console application showing how to configure and call it. Extract it, open START-HERE-DecisioQ.Sample.sln, select DecisioQ.Sample, and run it; or use dotnet run --project .\DecisioQ.Sample\DecisioQ.Sample.csproj.
Node.js 18+
Open a terminal in the extracted node folder and run npm start. The sample uses Node's built-in fetch, so no package installation is required.
Python 3.9+
Open a terminal in the extracted python folder and run python app.py. It uses only the Python standard library.
Go 1.21+
Open a terminal in the extracted go folder and run go run .. No third-party modules are required.
Java 11+
Open a terminal in the extracted java folder, run javac DecisioQSample.java, then java DecisioQSample. It uses Java's standard HTTP client.
PHP 8.1+
Ensure the PHP cURL extension is enabled, open a terminal in the extracted php folder, and run php sample.php.
Windows visual sample packages
Ready-to-run application: decisioq-windows-visual-sample-7.6.3.zip contains the compiled, self-contained Windows x64 application. Choose this package when you want to run the visual sample immediately. It does not require Node.js, the .NET runtime, the .NET SDK, Visual Studio, or administrator installation.
Developer source: decisioq-windows-visual-source-7.6.3.zip contains the editable ASP.NET Core 8 project source, including Program.cs, the project file, web UI, prepared request, and README. Choose this package when you want to inspect, modify, build, or integrate the application. Building it requires the .NET 8 SDK or Visual Studio 2022 with ASP.NET development support.
Run the ready-to-run package:
- Download
decisioq-windows-visual-sample-7.6.3.zip. - Right-click the ZIP, select Extract All, and open the extracted folder.
- Double-click
DecisioQ.VisualSample.exe. - Keep the console window open and note the local address it displays. The application normally uses
http://127.0.0.1:7076; if that port is occupied, it selects the next available port through7095. - If the browser does not open automatically, enter the displayed local address manually.
- Enter the API Consumer client ID and secret, select Use credentials, and then select Run Decision.
- When finished, close the console window or press
Ctrl+C.
Visual web sample
This alternative is intended for Node.js users. Extract the package, set the credential environment variables, and run npm start. Open http://localhost:7076. The browser provides an editable form while the local Node.js server protects the credentials and calls the APIs.
Postman
Import both the collection and environment JSON files into Postman. Select the imported environment, enter the client ID and secret in its current-value fields, then run the authentication request followed by a decision request. Do not save real credentials into a shared or exported environment.
Operate the integration
Error recovery, security, billing behavior, onboarding, and support diagnostics.
Versioning and governance
Compatibility expectations, release history, and the requirements for a genuine isolated sandbox.
