Vansah API Bindings allow automated test frameworks to push execution results, logs, and evidence directly into Vansah Test Management for Jira.
This enables real-time, code-driven test execution reporting while preserving Vansah’s traceability, plans, and reporting model.
This page acts as a single entry point for all supported languages.
Supported languages
Vansah provides API bindings for multiple automation ecosystems.
Language | Status |
Java | |
JavaScript | 🔜 Coming soon |
Python | 🔜 Coming soon |
C# / .NET | 🔜 Coming soon |
Other frameworks | 🔜 Planned |
How Vansah API Bindings work (language-agnostic)
Regardless of language, every Vansah API binding follows the same execution pattern:
Authenticate using a Vansah Connect token
Create or locate a test run in Vansah
Execute automated tests in your framework
Send execution results, step logs, and attachments to Vansah
View results instantly in Jira within Vansah
This ensures consistency across teams, tools, and languages.
Java API Binding
The Vansah API Binding for Java enables Java-based automation frameworks to integrate directly with Vansah.
Supported Java test stacks
The Java binding works with:
Selenium
Playwright (Java)
JUnit
TestNG
Cucumber
Maven-based test frameworks
Prerequisites (Java)
Before using the Java binding:
Vansah installed in your Jira workspace
A valid Vansah Connect token
Java JDK 8+
Maven-based project (recommended)
Installation (Java)
1. Add Maven dependencies
Add the required dependencies to your pom.xml:
org.apache.commons:commons-lang3com.mashape.unirest:unirest-java
These libraries handle HTTP communication and utilities used by the Vansah client.
2. Add the Vansah Java client
Copy the VansahNode.java file from the repository into your test project.
Typical location:
src/test/java/...
This class acts as the execution bridge between your test framework and Vansah.
Authentication (Java)
You can configure authentication in two ways:
Option 1 — Static token configuration
Set the Vansah Connect token directly inside VansahNode.java.
Option 2 — Runtime configuration (recommended)
Set credentials dynamically in your test setup:
Vansah Connect token
Vansah API URL (from Vansah → Settings → API Tokens)
This approach is better for CI/CD pipelines and environment-based execution.
Creating test runs (Java)
The Java binding supports multiple execution models depending on how your team uses Vansah.
Create a test run from a Jira issue
Use when your automation maps directly to a Vansah test case key.
Create a test run from a Vansah test folder
Use when executing grouped test assets.
Execute under a Standard Test Plan (STP)
Use for consistent regression or release-level execution tracking.
Execute under an Advanced Test Plan (ATP)
Use when execution is driven by structured plan assets.
The same concepts will apply across all future language bindings.
Logging execution results (Java)
During execution, your tests can:
Log pass / fail / blocked outcomes
Add step-level comments
Attach screenshots or files
Update existing logs
Remove runs or logs (for cleanup scenarios)
This enables detailed reporting and faster investigation inside Vansah.
Common configuration fields (Java)
Set execution context before sending results:
Jira issue key
Test folder path
Sprint name
Release name
Environment
Test plan key (Standard or Advanced)
These fields ensure results appear in the correct Vansah context.
Error handling & troubleshooting (Java)
If results do not appear:
Verify Vansah Connect token
Confirm API URL
Check network or proxy settings
Validate folder path format
Ensure dependencies are included
The Java binding includes built-in logging to help diagnose failures