# Create API Test

## Conektto's Autonomous API Test Studio

Upload API specification, connect data store, let Conektto's NLP engine does the magic of attributes to entity mapping, you are now ready to publish and create your API test harness.

## Log in to Conektto

1. Go to [www.conektto.io](http://www.conektto.io). The Conektto page displays.
2. Select **Sign up/Login**.The Conektto **Login/Sign up** page displays.
3. Select **Continue with Linkedin**. The **Linkedin Login** page displays.
4. Enter Email ID and Password, and select **Sign in**. The **Conektto Authenticator** page displays.
5. Select **Allow**. The Conektto API project page displays that allows you to create an API project.
6.

## Create a Test API Project

1. Follow instructions from 1 to 6 in the **Log in to Conektto** section.
2. Select **Test Studio**. The **Test API Project** page displays.
3. Select **Create New API Project**. The **Create API Project** page displays.
4. Enter the **API Name** and select **Upload** to upload the specification file.
5. Select the **Connect Database** tab.
6. Select SQL Server as the **Server Type**.
7. Enter **34.82.24.189** in the **Host** field and **1433** in **Port** field.
8. Enter Username, Password, and Database.

   **Note**: Select **Over SSL** checkbox to upload **Key**, **Certificate**, and **CA Certificate.**
9. Select the **Invite Collaborators** tab to enter name of people in the **Invite users to collaborate**.

   **Note**: Select skip for now if you do not want to enter any collaborator's name.
10. Select **Next**.

## Video Overview

Check out a video overview of our product below.

{% embed url="<https://www.youtube.com/watch?v=ywAo0LZ6k-o>" %}

\
Create your API tests
---------------------

\
:white\_check\_mark:From [Conektto ](https://app.conektto.io/signin)dashboard, Click on **"Create New API"**

![Step 2 screenshot](https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/a3de7424-2700-4749-8187-1c868c8c164b/5f0ebacd-8a34-4c8e-8af3-3b15f4be8842.png?crop=focalpoint\&fit=crop\&fp-x=0.0753\&fp-y=0.1235\&fp-z=3.0665\&w=1200)

#### :white\_check\_mark: Click on Test Studio dialog

![Step 3 screenshot](https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/52c3062e-b3e8-4d01-8df7-97cdf02aa1ea/16b51798-a64b-4470-a8b5-17c21be25cec.png?crop=focalpoint\&fit=crop\&fp-x=0.4944\&fp-y=0.6610\&fp-z=3.0665\&w=1200)<br>

#### :white\_check\_mark: Type a name for your API Test Project <a href="#type-a-name-for-your-api-test-project" id="type-a-name-for-your-api-test-project"></a>

![Step 4 screenshot](https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/f0f1bfcf-dc6a-4579-95c3-ca55725d2b46/fea5145e-31b6-404f-a7ad-2ae6a71286c7.png?crop=focalpoint\&fit=crop\&fp-x=0.5000\&fp-y=0.3280\&fp-z=2.6669\&w=1200)

### Upload Spec

#### :white\_check\_mark:Upload API Specification (JSON)  <a href="#upload-api-specification-json" id="upload-api-specification-json"></a>

Upload your desired API Specification for which you would like to build tests.

If you would like to try out our examples, select "Use default BikeStore Spec" and click Next to add collaborators.

![Step 5 screenshot](https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/e92000b3-ed4f-4f7b-a975-5ac8ecb1077e/5f86dd88-a52e-49ac-ae54-b43abccc5d0e.png?crop=focalpoint\&fit=crop\&w=1200)<br>

### Connect Database

#### :white\_check\_mark:Click Next to connect your database <a href="#connect-your-database" id="connect-your-database"></a>

Select Database Server Type, and provide host credentials for the desired database under test. You may also choose to connect to your database through SSL. You are required to upload your SSL certificates if you choose to do so. Click "Test" to test the database connection. If you have trouble in connecting the database, check "[Support](https://docs.conektto.io/product-guides/broken-reference)" section for additional details.

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FBRHLGUDncvEeklDiavHc%2Fimage.png?alt=media&#x26;token=e050ebaa-cabc-4911-b4aa-94b970ba2079" alt=""><figcaption></figcaption></figure>

### Invite Collaborators

#### :white\_check\_mark:Click on "Invite Collaborators"

APIs are no good designed, built or tested in silos. Invite your desired users or stakeholders that you would like to share the API test project by providing their email id. The respective users will get an email with a link for collaboration.

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FwuW2Dt8FAmW1bkVwQEhd%2Fimage.png?alt=media&#x26;token=36037173-d4b2-409f-b62d-0479fe73d756" alt=""><figcaption></figcaption></figure>

#### :white\_check\_mark:Click on "Done" to continue with collaborators or "Skip for now" to add collaborators later

#### :white\_check\_mark: Conektto's engine now scans your API schema, your database, runs our patent pending NLP matching process before loading your API test studio designer.&#x20;

:warning:This process may take several minutes based on the complexity of your schema, database and volume of data.&#x20;

<table data-card-size="large" data-column-title-hidden data-view="cards"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td></td><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/878b1171-b43a-4a9c-aaf9-1bf72d6b30a7/c7fe6d23-0880-4a3d-81b9-a6424d2c3204.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.5000&#x26;fp-y=0.5187&#x26;fp-z=2.5928&#x26;w=1200" alt="Step 16 screenshot"></td><td></td></tr><tr><td></td><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/7a6497e1-5fe4-4040-8e54-282839bcf458/a407cf32-8a8a-42c3-a38f-a6dfbf6acc93.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.5000&#x26;fp-y=0.5187&#x26;fp-z=2.5928&#x26;w=1200" alt="Step 17 screenshot"></td><td></td></tr></tbody></table>

#### :white\_check\_mark: After successful scanning and matching, you will be presented with Test Studio with all your schema resources pre-loaded with RestAPI contracts as well as established matches as <mark style="background-color:green;">Full Match</mark>, <mark style="background-color:orange;">Partial Match</mark> or <mark style="background-color:red;">No Match</mark>

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2Ft4fcwiVOdlpK8vBix80F%2Fimage.png?alt=media&#x26;token=fb1279f3-b7b4-4755-a0d1-dc199d72e87c" alt=""><figcaption></figcaption></figure>

<details>

<summary>How Conektto's matching logic works?</summary>

**Conektto scans:**

:information\_source: API schema attributes, data types, components, paths and operations

:information\_source:Database schema, entities, relationship, order and sequence as well as samples data

**Conektto NLP based matcher:**

:information\_source:Extracts the natural language from the scanned information, matches that based on the meta data components like data type, pattern, descriptive information as well as use language / dictionary library to find meaning and relevancy

:information\_source:When able to establish a match, provides a FULL MATCH with actual matched entity (table and column).&#x20;

:information\_source:When partially able to establish a match with one or many, provides a PARTIAL MATCH along with entity recommendations

:information\_source:When inconclusive, marks as NO MATCH

**User override**

:information\_source:Users can override Conektto recommended match by custom selection of entities.

:information\_source:Select the schema and respective attribute. Click on the Full,Partial or No Match icon to examine the actual match or override as desired.

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2Fa6tPYIkGqsQ3UEUnciOG%2Fimage.png?alt=media\&token=c6436d9f-0deb-4310-9d78-a104c16fdec0)  ![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FGPAYcN7gMB9Q0hVURziA%2Fimage.png?alt=media\&token=3c0fa0ec-5dac-4082-9377-cd0118d7fb39)  ![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FqcbD4hEtHmNKiJaUvZjT%2Fimage.png?alt=media\&token=19f95bd2-ccb3-43c2-9f70-ce70010cc569)

</details>

### Examine Schema and Simulate payload

:white\_check\_mark:**Visually examine the Schema**&#x20;

Inspect the operations pre-loaded from the Schema and examine for correctness and completeness of RestAPI operations and contracts.

<table data-view="cards"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FVhHRuHQMQj10UH47HE9j%2Fimage.png?alt=media&#x26;token=c3d49af1-b4ae-484d-bb26-7a07673adbb0" alt=""></td><td></td><td></td></tr><tr><td></td><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/4f9b7e16-3558-4553-bd70-ab74261535e9/0aed2e43-a25c-473d-9960-96079063e240.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.5698&#x26;fp-y=0.6074&#x26;fp-z=3.0665&#x26;w=1200" alt="Step 21 screenshot"></td><td></td></tr><tr><td></td><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/19d4e8a7-3a2d-4c5f-992f-dfb7bbc89c76/75801036-8e87-4186-8dc3-a742f05d164d.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.3385&#x26;fp-y=0.5432&#x26;fp-z=3.0665&#x26;w=1200" alt="Step 23 screenshot"></td><td></td></tr><tr><td></td><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/540cb512-cd15-45ff-bb94-274501b3883d/a1723d70-da5b-481b-9450-45db52a361ef.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.3392&#x26;fp-y=0.6744&#x26;fp-z=3.0665&#x26;w=1200" alt="Step 24 screenshot"></td><td></td></tr><tr><td><p></p><p><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/78ecbbc4-c71c-463a-9463-09590fe2f7e6/1b74231c-4da6-42df-b95d-2e6a3f814cb4.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.1778&#x26;fp-y=0.7805&#x26;fp-z=4.3179&#x26;w=1200" alt="Step 25 screenshot"></p></td><td></td><td></td></tr></tbody></table>

:white\_check\_mark:**Visually simulate the payload**

:information\_source:Click "SEND" to simulate the request, response payload structure.

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F2kD6vIIOAlL33dI1k981%2Fimage.png?alt=media&#x26;token=24d5c881-5bf7-4e06-a154-a815241700e3" alt=""><figcaption></figcaption></figure>

### Pre-Publish: Validations and Mapping

After confirming the contracts, click **"Publish"**

![Step 47 screenshot](https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/9f0e218a-0b4b-42f9-acd4-bb575ff75964/428548a3-4b41-4cf2-9b5a-e6a2ebaaecec.png?crop=focalpoint\&fit=crop\&fp-x=0.9309\&fp-y=0.0371\&fp-z=3.0665\&w=1200)<br>

Publish action prepares your API contracts, schema and entities selected for validation against OpenAPI standards as well as mapping complex business logic.

### &#x20;:white\_check\_mark: **Validations**

Conektto assures thorough validation of API standards. The following are various levels of validations if not addressed, your publish would fail:

1. Naming conventions
2. Descriptions, optional and mandatory parameters
3. Correctness of Operations and components
4. Completeness of Operations Status codes
5. Bare minimum structure of a RestAPI contract (Header, Request Body, Response Body)

### :octagonal\_sign:**Mandatory mappings**

:information\_source:For Conektto to publish API test artifacts, schema attributes are required to be mapped with database entities. You will be prompted with below mandatory mapping steps:

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FzsxuQk3msGDS8IzhyXzT%2Fimage.png?alt=media&#x26;token=9cbd1917-9308-4cc9-b9a6-3c97275bae5e" alt=""><figcaption></figcaption></figure>

:warning:Select appropriate attributes and respective entities to be mapped. Click **"Save and Publish"**

<figure><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FE0eHsupMXFKTGdWceBEU%2Fimage.png?alt=media&#x26;token=fb602a51-be35-430f-b0ce-63800d8933c8" alt=""><figcaption></figcaption></figure>

### :white\_check\_mark: Business logic: Relationship, joins and filters

:warning:Conektto allows users to validate existing entity relationships. Where the database is not normalized, you are able to define custom mapping between the entities. Additionally users can create Filter conditions for the API. <br>

:heavy\_check\_mark:**Derived Entity Maps** - preloaded maps based on database schema scanning

:heavy\_check\_mark:**User Defined Entity Maps** - custom maps defined by user

:heavy\_check\_mark:**Filters** - custom filter conditions annotated by user

<table data-view="cards"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FX52ATodNzNusDNJ96ZT9%2Fimage.png?alt=media&#x26;token=f98ca5c4-c46f-42ea-8f21-757c7a8feaaa" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FUIE5gEm01nw3jQjH7whX%2Fimage.png?alt=media&#x26;token=270b85c8-a2f7-45c0-9481-a017060a2281" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FChftG6L6gC6AP5CKw8oj%2Fimage.png?alt=media&#x26;token=64360c67-d01c-46ea-b9fe-309ea0404268" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FM9fV693TjTPVg2mmLtCU%2Fimage.png?alt=media&#x26;token=15240f7e-ae73-4f11-848d-08d9ce385d43" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F7LRHlUt2kHRAiB47JIsD%2Fimage.png?alt=media&#x26;token=9c19f7c3-a8f8-4957-b7f3-0b5c94c7abff" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FwC3IKjQfGnYWdIA6IOWm%2Fimage.png?alt=media&#x26;token=9ecb06f8-5bd5-4e93-a813-2df218eba03f" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F3p41UM5zWUgYGGMrtnVk%2Fimage.png?alt=media&#x26;token=71711f05-2d7c-4284-a08e-ad45be2b0337" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FsB9aF1EPkTP0tOppHv6F%2Fimage.png?alt=media&#x26;token=d2688332-f543-4ce2-86e0-c3f23171e0e1" alt=""></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FGmo41mYjnlvh8wsWqp7g%2Fimage.png?alt=media&#x26;token=548743de-3f25-47ed-aa85-97bdfdcaf1ef" alt=""></td><td></td><td></td></tr></tbody></table>

:warning:You will be prompted to confirm the database host credentials for final domain model validation.&#x20;

![](https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2FZvAUVD7TSSJCH5LGEMON%2Fimage.png?alt=media\&token=4313905b-47be-4b43-a942-1610f04fc5a3)

### :white\_check\_mark:**Completing Publish**

:information\_source:Click "Publish". Conektto will create your Autonomous API Test Harness ready to be downloaded from the Dashboard.

<table data-view="cards"><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/5bd70b26-965e-4655-94ea-4db369eb567d/509ad6a5-157e-4e95-8558-0b91ef639a3e.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.6687&#x26;fp-y=0.7393&#x26;fp-z=3.6528&#x26;w=1200" alt="Step 63 screenshot"></td><td></td><td></td></tr><tr><td><img src="https://1552445785-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAy7Mp511XMtJ39Y6AhW%2Fuploads%2F8B8XAUG3uYWkjg0pVHtQ%2Fimage.png?alt=media&#x26;token=e634a2a0-024d-4347-96ea-22de3f44bcd7" alt=""></td><td></td><td></td></tr><tr><td><img src="https://images.tango.us/workflows/f2c4a6a7-e9fb-426c-b5d0-038b097ae214/steps/d6711664-79e0-45ec-8e8b-c308d76260ef/4f919f88-ca44-4a09-acf3-f5a916dbe29d.png?crop=focalpoint&#x26;fit=crop&#x26;fp-x=0.5000&#x26;fp-y=0.4930&#x26;fp-z=2.8446&#x26;w=1200" alt="Step 65 screenshot"></td><td></td><td></td></tr></tbody></table>

####

####