API Settings

API Settings will configure the APIs and later the APIs can be used where it is needed. As a consequence, API can be used in a ubiquitous way.

Create New API

With the API name and the description, the API can be created.

Create API

Now it's time to configure the API.

API Method

API method can be GET, POST, PUT, PATCH, or DELETE. Attribute/Variable can be used in API Endpoints which is like path variable.

Header, Parameter, and Body can be added as needed according to APIs. Attribute/Variable can be added as value in this key-value pair.

Header: key-value
Parameter: key-value

Body section has 2 types. - URL Encoded - RAW

Body: URL Encoded
Body: RAW Json

Test Request

After the API configuration, it's time to test whether the API is working properly or not. While testing, it will provide the response with the status code. The test response is feasible to make a copy and to present with an expandable view.

Test Response

Sample Variable can be added to test request. Basically, it inputs dynamic values to attributes while testing and this section is optional.

Sample Variable

Save Response

Response from the API can be saved easily where the attribute will hold the specific JSON path response. Even the complete JSON response can be saved in the attribute.

Save Response

Dynamic hint is applicable while entering the JSON Path.

Dynamic Json Path Hint

After the proper API configuration, the API can be Published or Save as Draft.

  • Published API means it's status is LIVE and ready to use.

  • DRAFT status represents that the API is in a draft state and is not ready to use.

Status can be changed from draft to live and live to draft. Search and filter are available. /

LIVE & DARFT Status

Last updated

Was this helpful?