# Type 3 – Import Postman API Collections

Let’s see what steps are required to import a Postman Collection to the *API Browser*.

1. Open an Integration Project.

![](/files/xGelqU6DkCdECh4rrOJP)

2. Open the *API Browser* through *View* > *Data Service* > *API Browser*.

![](/files/5ousCVZm71iTzzWwF2vw)

3. Click on the *Import API* option on the *API Browser*.

![](/files/HhYp0dLY4uPnrd7HEMNT)

This will open the *Import API* window.

![](/files/sxcohpPYwRTXwqksRQLg)

4. Select *Postman collection* from the *API Import Source* drop-down.

![](/files/rd5K0j3AN9ghIEzqVsab)

5. Browse and provide the path to the *Postman Collection* and click *OK*.

![](/files/qC9p4tSJGY6SI8ZoXYQ9)

If there is already a Shared Connection available, then we can re-utilize it, instead of auto-generating a new one, by checking the *Use Existing Connection* checkbox.

Once the *Postman Collection* is successfully imported, it will populate the API Browser with the available endpoints.

![](/files/QPQ8NUeOD7CL1QZ9SUHc)

{% hint style="info" %}
**Note:** It is recommended by Postman to export the collections in v2.1 format files. Therefore, Astera restricts the user to import only a v2.1 Postman Collection.
{% endhint %}

The Centerprise API file (.capi) and Shared Connection files will automatically generate and be saved in their respective folders.

![](/files/6LynCRFachMtwE8gu0ew)

6. Now, drag-and-drop any endpoint onto a logic designing artefact i.e., a Dataflow to consume.

![](/files/mQMGN1IJe9CqwO4qmnoA)

### Postman Collection Format

#### Variables Convention

To import a *Postman Collection* to the API Browser successfully, we must follow certain conventions:

The Postman collection must include a variable, namely *baseUrl*. (This variable is not case sensitive)

![](/files/953ZHG6tgBhAGbyPdrgA)

{% hint style="info" %}
**Note:** A collection in which the *baseUrl* variable contains a special character(s) will not be imported.
{% endhint %}

All other variables, except for the *baseUrl*, will be discarded.

During the import, the *baseUrl* variable defined in all the endpoints will be replaced with the Base Url text box value in the Shared Connection.

![](/files/FRtmKth0PZxarazbeNzQ)

This means that the Shared Connection’s Base Url will be populated with the *baseUrl* variable’s Current Value that is defined under the Variable section in the collection.

![](/files/2CjW6Fm97r5YATBAhVkx)

![](/files/Hv05JVqls9GsgFPGTvXB)

### Preservation of Authentication Information

All valid Postman Collections will be imported with pre-configured Shared Connections. These Shared Connections will have the same Authentication Type selected as in the collections i.e., API Key, Auth Code, Client Credentials, etc.

{% hint style="info" %}
**Note:** Confidential data such as credentials are imported for security and protection.
{% endhint %}

#### Example of an API Key Security Type

![](/files/DBbbRs3azVwJDp7bdwvd)

#### Example of an OAuth 2.0 Security Type

![](/files/6RZRijpVurFF8QDibHS0)

### Preservation of Endpoint’s Configuration

Upon importing a Postman Collection, each endpoint’s configuration i.e., methods, resources, parameters, and request/response payloads will also be preserved.

#### HTTP Method and Resource

![](/files/ub9515IOxoeiULdwPRY8)

#### Parameter

All parameters with their respective default values are populated in the API Client’s Parameter window.

![](/files/K8vFLAC74vbJR6X0yIHd)

{% hint style="info" %}
**Note:** Sensitive data such as the URI parameter value is not preserved for security.
{% endhint %}

#### Payload

The input and output layouts/payload are structured in the respective Input and Output Layout windows. Additionally, the sample text bodies used to generate the layouts are preserved in the Sample JSON Text window.

![](/files/5HTC4KKVdWgutN7cVpTe)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.astera.com/astera-data-stack-v10/api-flow/api-consumption/consume/api-browser/type-3-import-postman-api-collections.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.