Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 8 additions & 19 deletions src/pages/docs/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,44 +78,33 @@ Let’s use the first URL & retrieve the IDs of projects.

Follow the same steps from 4-6 with the other URLs mentioned in step 3 to get details of applications and uploads.

Here’s a quick GIF demonstrating how to retrieve IDs of projects, applications, and uploads using APIs in Postman.
![Workflow to retrive URL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/getidspostman.gif)


### **Get IDs using Testsigma API**

1. Create a **Test Case** by navigating to **Create Tests > Test Cases**.
![Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsapitc.png)

1. Create a **Test Case** by navigating to **Create Tests > Test Cases** and create a new test case.
![Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_1.png)

2. Add a **REST API Step**.
![REST API Test Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsrestspiteststep.png)

![REST API Test Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_2.png)

3. On the **REST API** page, select **GET** from the method dropdown.
![GET Method](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsgetmthod.png)
![GET Method](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_3.png)

4. On the **URL Textbox**,
![URL Textbox](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsurltb.png)
![URL Textbox](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_4.png)
- Enter https://app.testsigma.com/api/v1/projects to get project IDs.
- Enter https://app.testsigma.com/api/v1/applications to get application IDs.
- Enter https://app.testsigma.com/api/v1/uploads to get upload IDs.

Let’s use the second URL & retrieve the IDs of applications.


5. Click on **Authorization**, select **Authorization type** and enter the **Token**.
![Authorization](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsapiauth.png)

![Authorization](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_5.png)

6. Click on **Send** to retrieve details of all applications.
![Send](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tssendapi.png)
![Send](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_6.png)

7. You’ll find IDs of all applications in the response body.


Here’s a quick GIF demonstrating how to retrieve IDs of projects, applications, and uploads using APIs in Testsigma.
![Workflow](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/getidtestsigma.gif)
![Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_api_overview_7.png)

---

Expand Down
Empty file.
4 changes: 2 additions & 2 deletions src/pages/docs/atto/generative-ai/integrations/qtest.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ With qTest integrated into Testsigma, you can generate test cases by selecting s
## **Steps to Integrate Testsigma with qTest**

1. From the left navigation bar, go to **Settings > Integrations**.
![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TestRail_Navigation.png)
![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/integration/update_linear_1.1.png)

2. Enable toggle on **qTest** widget.
![qTest Widget](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/qTest_Widget.png)
![qTest Widget](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/integration/update_qtest_1.png)

3. On the **qTest Details** dialog, enter **Host URL** and **Bearer Token**.
![qTest Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/qTest_Details.png)
Expand Down
11 changes: 9 additions & 2 deletions src/pages/docs/configuration/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,19 @@ You can access and control it programmatically once you generate the API key. Te
Follow the below steps to generate an API key in Testsigma:

1. Navigate to **Settings** > **API Keys** in the left-side navbar.
![Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/update_apikeys_1.png)

2. Click the **Generate new API Key** button in the top right corner of the screen on the **API Keys** page, and a **Generate API Key** pop-up overlay will appear.
![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/update_apikeys_2.png)

3. In the pop-up overlay for **Generate API Key**, you can enter a **Name** for your **API Key** and specify the **number of parallel test** executions for this key. The overlay provides a toggle for restricting parallel test execution for this key.
3. In the **Generate API Key** dialog, enter a **Name** for your API key and define the number of parallel test executions. You can also use the toggle to restrict parallel execution for this key.
![Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/update_apikeys_3.png)

4. After entering a name and configuring parallel settings, click the **Generate Key** button. The API key will be displayed on the screen. Click the **Copy API Key** button to copy it to your clipboard for use in your applications or scripts. ![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/generate_apikey.gif)
4. Select the desired validity period for the API key under **Expiration**.
![Expiration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/update_apikeys_4.png)

5. After entering a name and configuring parallel settings, click the **Generate Key** button. The API key will be automatically copied to your clipboard so you can easily use it in your applications or scripts.
![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/update_apikeys_5.png)

[[info | **NOTE**:]]
| Only users with **Admin** or **Super Admin** roles can generate API keys in Testsigma.
Expand Down
8 changes: 4 additions & 4 deletions src/pages/docs/continuous-integration/travis-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,18 @@ Below we will cover the steps in 3 parts:
## **Obtain API and Test Plan ID from Testsigma App**

1. To get API key, navigate to **Settings > API Keys** and click on **Generate API Key**.
![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/trinapi.png)
![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_travis_1.png)

2. On **Generate API Key** overlay, enter **Name** and click on **Generate API Key**.
![Generate](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tringapi.png)
![Generate](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_travis_2.png)

3. On **API Keys** page, hover over the generated API and click on **Copy API Key**.
![Copy API](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/triapicapi.png)
![Copy API](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_travis_3.png)
Comment thread
Nandhini4501 marked this conversation as resolved.

We will use this API Key to authenticate our remote Test Plan trigger requests from Travis CI.

4. To get Test Plan ID, navigate to **Test Plans > Test Plan > CI/CD Integrations**. You will find the execution ID for the Test Plan within the **REST API call to start Test Plan** section.
![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/trineid.png)
![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_travis_4.png)


We will be using this Test Plan ID to specify which Test Plan to trigger from Travis CI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ Below is a list of countries with their corresponding two-letter country codes t
## **Using Desired Capability to set the Location**

1. Click **Run** from **Test Case Details** page.
![Run Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/AdHoc_Run_DC.png)
![Run Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_geolocation_1.png)

2. On the **Ad-Hoc Run** overlay, click **Desired Capabilities**.
![AdHoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Desired_Capabilities_AdHoc_Page.png)
![AdHoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_geolocation_2.png)

3. Enter ***geoLocation*** in the **Key** field, select ***String*** as **Data type**, and set the **Value** as per country's country code.
![Desired Capability](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Desired_Capabilities_GeoLocation.png)
![Desired Capability](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_geolocation_3.png)

4. Click **Run Now** to execute the test case.
![Run Now](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/RunNow_geoLocation.png)
![Run Now](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_geolocation_4.png)

---
33 changes: 15 additions & 18 deletions src/pages/docs/elements/locator-precedence.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,34 +34,31 @@ While creating tests for web applications, identifying locators accurately for U

## **Configuring Locator Precedence**

1. From the left navigation bar, go to **Create Tests > Elements** and click **Record**.
![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lprerec.png)
1. From the left navigation bar, go to **Create Tests > Elements**.
![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_1.png)

2. This will open a new window with the test recorder and will be ready to start recording. Here, we entered the URL for Simply Travel Web.
![Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lpstws.png)
2. In the Elements list page, click **Record**.
![Record](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_2.png)

3. On the test recorder, click on **Locator precedence**.
![Locator Precedence](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lpbotsrec.png)
3. This will open a new window with the test recorder and will be ready to start recording. Here, we entered the URL for Simply Travel Web.
![Window](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_3.png)

4. This will open the **Locator precedence** overlay on **Recorder**.
![Recorder](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lplpovrly.png)
4. On the test recorder, click on **Locator precedence**.
![Locator Precedence](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_4.png)

5. Use the **Drag Handle** to configure the priority of locators.
![Drag Handle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lopredlpdrghndlrghndl.png)
5. This will open the **Locator precedence** overlay on **Recorder**.
![Recorder](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_5.png)

6. Use the **Drag Handle** to configure the priority of locators.
![Drag Handle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_6.png)

[[info | **NOTE**:]]
| The **Locator precedence** configured for an application from a specific user accessible only to the same user & configured application.

6. Click on **Save** to save the configuration.
![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lpsve.png)
7. Click on **Save** to save the configuration.
![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/update_locator_7.png)

[[info | **NOTE**:]]
| Testsigma will revert to the default **Locator precedence** if you don't save the configuration.


Here's a quick GIF demonstrating how to configure locator precedence in test recorder.

![Test Recorder](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lctr.gif)


---
Loading
Loading