API Wizard is a guided step-by-step approach to creating API service connection calls and verifications. It helps a non-technical user to create robust API test logic simply by navigating through a series of screens.
When working in the Wizard, once you define the end point and the Request information, a sample API call is made to your service. This brings out a response, on which you can insert various types of verifications.
Wizard communicating with API service
When the wizard attempts to make a call to the API service being tested, there are two ways in which accelQ can attempt to make the connection.
- Directly through the browser where you are currently working (Browser-Connect ON)
- Connect to API service through the accelQ server. (Browser-Connect OFF)
Browser-Connect flag allows the wizard to access API service directly from browser, thus bypassing the access restrictions your API service may have. If you are using on-cloud version of accelQ, service calls from the server may be restricted.
Setting the flag
You can set the Browser-Connect flag ON/OFF by clicking on the link available in the title bar of the wizard.
Browser-Connect setting only for the wizard
It is important to note and distinguish that the Browser-Connect flag is only relevant while working in the wizard during test development. When the test is actually running, the actual API call is made from the Local Agent, which is invoked from within your network.
Cross-site scripting errors
Sometimes, based on your API implementation, direct browser connect may result in cross-site scripting errors. You can turn off the flag and try direct connection from the server. If the connection is not successful, you can always load a sample response and setup your verification points in the Wizard.