---
title: "API Testing Tools"
slug: "api-testing-tools"
updated: 2026-05-28T12:07:29Z
published: 2026-05-28T12:07:29Z
canonical: "learn.servitly.com/api-testing-tools"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://learn.servitly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Testing Tools

Below you can find out how to test API endpoints using different tools.

## Postman

With [Postman](https://www.postman.com/), you can use the following API collections that can be downloaded here.

[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/postman_collection.html)[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/httpconnector_postman_collection.html)

When downloaded, you can drag-and-drop the JSON file into your Postman window, or load it by using the Import function.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image-1729785898902.png)

Before starting to invoke any API endpoint, you must configure the collection variables.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(586).png)

### DPS API Variables

- *baseURL*: the base API URL related to the [target environment](/apidocs/api-main-concepts#endpoints).
- *tenantName*: the name of the tenant you want to connect to (e.g. acme).
- *apiKey*: the [key](/docs/api-keys) used to make API requests.

According to the authentication method you should edit different variables:

- [Login with credentials](/apidocs/user-login-credentials):
  - *userEmail*:the email address of the DPS user.
  - *userPassword*: the private password of the DPS user.
- [Login with PAT](/apidocs/user-login-pat):
  - *userPat*: the [PAT](/docs/personal-access-tokens) (Personal Access Token) to be used in alternative to user credentials (email and password).

Once variables have been provided, you can start testing the API endpoints without having to manage tokens or special headers (e.g., X-Servitly-Tenant).

> [!NOTE]
> Automatic token management
> 
> The collection declares a *post-response* script which automatically updates the authentication variables:
> 
> - *bearerToken:* the token sent in the *Authorizatio*n header for each authenticated endpoint.
> - *refreshToken, userId, tenantId*: these variables are used by the *logout* and *renewToken* endpoints.

### HTTP Connector Variables

- *httpConnectorBaseUrl*: the base API URL of the HTTP Connector endpoints related to the [target environment](/apidocs/api-main-concepts#endpoints).
- *basicAuthUsername*: the username configured in the HTTP Connector mapping of a thing.
- *basicAuthPassword*: the password configured in the HTTP Connector mapping of a thing.

### Environments

In case you are working on multiple environments (e.g. DEV, STAGING, PRODUCTION), below you can find the variable sets for each environment type. Simply download the ones you need and drag them into the Postman window, or use the import function inside the *Environments* section of your workspace.

**AWS**

[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/pm_env_aws.html)

**AZURE**

[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/pm_env_azure.html)

In Postman, within an Environment, you can redefine these variables: *apiKey*, *userEmail, userPassword, userPat*. When testing the API, you can select the target environment.

![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(587).png)

## Swagger UI

The Servitly API definitions are also available in the [OpenAPI](https://swagger.io/specification/) format (version 3.1.0) that can be downloaded here.

[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/openapi_collection.html)[Embedded content](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/httpconnector_openapi_collection.html)

In the alternative, you can use the online Swagger UI tool:

- [Servitly DPS API](https://editor-next.swagger.io/?url=https://docs.servitly.com/resources/api-reference/servitly_dps_api_openapi_3.1.yaml)
- [Servitly HTTP Connector](https://editor-next.swagger.io/?url=https://docs.servitly.com/resources/api-reference/servitly_http_connector_api_openapi_3.1.yaml)

> [!WARNING]
> Note that, with the Servitly DPS API, the bearer token must be manually provided and cannot be automatically extracted by the login response. For this reason we suggest you use the Postman collection which uses the post-request script to update variables automatically.