Vansah API bindings are small client libraries that let your test code report results to Vansah. Choose the binding for your automation language, configure your connection, and call its reporting methods from your tests or framework hooks.
Choose your language
Language | Setup and examples | Official source |
C# (.NET) | ||
Java | ||
Python |
Use the prod branch of the selected repository. Follow that binding’s instructions for its runtime, dependencies, method names, and supported options.
Before you begin
Install Vansah on your Jira site and confirm access to the Jira space where results should be recorded.
Generate a Vansah API token for an account with permission to execute Test Cases. Store it in your IDE or CI secret settings.
Find your workspace’s Vansah API Connect URL. Use the URL for your own workspace and configure it as the binding instructs.
Identify the existing Test Cases and the work item, Test Folder, or Test Plan context where you want to record results. For a Test Plan, select an existing iteration.
Connect your automated tests
Add the chosen binding and its dependencies to your test project.
Configure the Vansah API URL, token, and Jira space key. Preserve exact method names from the language guide.
Configure the test context using readable Test Case and work item keys, folder paths, or Test Plan keys supported by that binding.
Create the Test Run using the method for that context. Check that run creation succeeded before sending step results.
Call the binding from your test code to record the actual outcomes and comments. Add screenshots using the supported attachment method when needed.
Open Vansah in the same Jira space and check the saved Test Run, step results, comments, and evidence.
The binding does not automatically detect framework pass/fail outcomes. Keep your test assertions and add reporting calls at the appropriate test step or completion hook.
Use readable values in your integration
Test Case: use a readable key such as
DEMO-C46.Jira work item: use its work item key, such as
DEMO-123.Test Folder: use its path, such as
regression/checkout/, together with the Jira space key. Folders do not have F-prefixed keys.Test Plan: use a P-prefixed key, such as
DEMO-P13, and the intended iteration. Advanced Test Plans also need the work item or folder requirement expected by the binding.
These values are examples. Replace them with values from your own Jira space. API names such as projectKey and project.key refer to the Jira space key.
If results do not appear
Check the binding’s console output for authentication, validation, or access errors.
Confirm the API URL, token, Jira space, Test Case key, and selected context.
Check the script step number and accepted result values in your language guide.
Confirm that the Test Run was created before sending its step results.
Verify the saved result in Vansah. A passing framework test alone does not confirm that reporting succeeded; error handling differs between bindings.
Integrate without a binding
You can also call the Vansah REST API from your automation tool. Use the Vansah API guides for endpoint methods, request bodies, authentication, and examples.