---
title: API Test
description: "BQ also provides it's users the functionality to create and execute API tests within the platform itself.  #### **How to create an API Test?** 1. Navigate to Test Case screen. 2. Create / select a module. 3. Click on **Add…"
url: "https://bqurious.com/docs/api-test/"
updated: "2021-02-28"
category: Testing with bQurious
---

# API Test

BQ also provides it's users the functionality to create and execute API tests within the platform itself. 

#### **How to create an API Test?**

1. Navigate to Test Case screen.
2. Create / select a module.
3. Click on **Add Test** button.
4. Under Test Case Detail tab, enter the meta-data and select *Type*as API.
   ![](https://i0.wp.com/bqurious.com/wp-content/uploads/2020/11/Create-API-Test_Step-4.png?w=1200&ssl=1)
5. Click on **Save**.
6. Click on **Test Steps** tab.
   The API test template will be generated. Requests and Details sections will be displayed.

   ![](https://i0.wp.com/bqurious.com/wp-content/uploads/2020/11/Create-API-Test_Step-6.png?w=1200&ssl=1)

   The API template displays :
   1. Left Nav (Requests section) which lists steps. You can add, delete and move steps here.
   2. On the right (Details section) you have step group, url, credentials & tabbed grid for various inputs.

#### **How to execute an API Test locally?**

1. Click on **DESIGN**on left panel.
2. Click on **Test case**.
3. Select the test case to be executed.
4. Click on **Test Steps** tab.
5. Click on **Run** button.

#### **How to execute an API Test remotely?**

**Prerequisite :**

- Test case should be added to a Test Suite.

1. Click on **EXECUTE**on left panel.
2. Click on **Execute Automated Tests**.
3. Select the Suite that you wish to execute.
   You should be able to view the *'list of test cases'* under that suite along with its *'Last Execution Details'*.
4. Select the test cases that you wish to execute.
5. In the **Execution Details** section, please enter/select the below details. 
   - Run Name
   - Executing in Sprint (Select the sprint in which you are executing the test cases)
   - Build Number
   - Browser instance (the number of browse instances you wish to run the test cases on)
   - Distributed across Machines (Select the check box if you wish to distribute tests on various connected machines)
   - Execution Tags (if used any in the test cases)
6. If you expend the **Advanced Settings section**, you will see two options *Uninstall App (Mobile)* and *Clear App Data (Mobile). Clear App Data (Mobile) *checkbox will be checked by default. 
7. When you expand the **Execution machine(s)** section, you will see the **Desktop/Device(s)** section, where you should be able to view the connected machine's name and the browsers available on that machine.
8. Select the **browser**on which you wish to execute the test case.
9. Click on **Run Selected** button (if you have wish to execute selective test cases) or either click on Run All button (if you have wish to execute all test cases in the suite).

### *Related*