Use the Vansah API to connect automated tests, scripts, and development tools to your testing data. Postman lets you prepare requests and inspect responses before adding them to an integration.
Before you begin
Vansah is installed in your Jira site.
Your account can access the Jira space and perform the action you want to automate. API access follows the account’s Jira and Vansah permissions.
You have your API Connect URL and a private Vansah API token.
1. Open the API collection
Open the Vansah API collection.
If Run in Postman is available, select it and follow Postman’s prompts to add the collection to your workspace.
Choose the request for your task. Check its method, endpoint, parameters, and body against the matching Help Center API guide before sending it.
Imported sample collections can contain older routes or example values. Do not send requests with a sample host, token, Jira space key, or Test Case key.
2. Configure your connection
Create or select a Postman environment. Add
VANSAH_URLwith your API Connect URL andVANSAH_TOKENwith your token. Keep the token private and do not include it in shared exports or screenshots.Use your base URL followed by the complete endpoint path in the request URL. If an imported request uses different variable names, update those references to match your environment.
Set the
Authorizationheader to your Vansah token directly, without aBearerprefix. SetAccepttoapplication/json.For a JSON request body, use the raw JSON body option and set
Content-Typetoapplication/json.
Use the exact API field names in the guide. projectKey and JSON path project.key mean the Jira space key. An API Connect URL is a base address; it is not an Atlassian API URL or your Jira site URL.
3. Send a request and check the result
Start with a read-only lookup from the relevant API guide. Replace all sample values with values from your own Jira space.
Review the HTTP method and request contents. A create, update, or delete request can change Vansah data.
Select Send and inspect the HTTP status and JSON response. Check
success,message, and the returned data.For a change request, verify the resulting record in Vansah before repeating it. A timeout does not prove that a change failed.
For a complete Postman testing workflow that sends Passed or Failed results, see Report Postman Test Results to Vansah.
Troubleshooting
Problem | Check |
401 / authentication error | Correct workspace URL, valid Vansah API token, and a valid Atlassian connection for the account. |
403 / permission error | Jira space access and the Vansah permission required for the action. |
Validation error | Required fields, exact JSON nesting, supported names/keys, and the response’s message or field errors. |
No expected data | Selected workspace and Jira space, filters, and pagination. An empty result does not necessarily indicate an authentication problem. |
Use the status and error details in the specific endpoint guide; response handling can differ between operations.