# Postman importer

## Introduction

The **Postman importer** is used to build a connector from a Postman collection. You can:

* Upload a Postman collection from a file
* Provide a URL to a Postman collection

The Patchworks Postman importer will then attempt to:

* create the system/connector 
* create system variables 
* create authentication type (OAuth 1 & 2; Token; API key; Basic) 
* create authentication variables 
* create endpoints (including variables)
* enable the authentication type for all endpoints

{% hint style="info" %}
These are all the elements of a connector that you would expect to configure by using the [Connector Builder](https://doc.wearepatchworks.com/product-documentation/developer-hub/connector-builder) to build your connector manually.
{% endhint %}

Any item the importer cannot complete is flagged for you to add/adjust manually after the import.

## Need to know

* The maximum file size allowed for import is 50MB.

## Using the Postman importer

**Step 1**\
Locate the Postman file or collection URL that you want to use. 

**Step 2**\
Log into the Patchworks dashboard, then select **connectors & instances** from the left-hand navigation menu:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FU6OukflBgdzjWVTPRNmQ%2FPostman%20importer%201.png?alt=media&#x26;token=9d2ca97e-d3a9-4724-9207-c1be30a37218" alt=""><figcaption></figcaption></figure>

**Step 3**\
Click the **import Postman collection** link at the top of the page:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FQdAocF1OerpyeXV3SUjg%2Fpostman%20importer%201.png?alt=media&#x26;token=630b5d77-0070-4a33-9c80-0c59e51e03d6" alt=""><figcaption></figcaption></figure>

**Step 4**\
Choose whether to import a file, or to provide a URL:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FlwFGbHpJ6zQapPrmoCYT%2Fpostman%20importer%202.png?alt=media&#x26;token=c58657de-6e34-4de8-bf7b-e71732f77eac" alt=""><figcaption></figcaption></figure>

**Step 5**\
Select the appropriate option below for the next step:

<details>

<summary><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FPq80F8deQ3i4P3iazHRj%2Ficon%20decision.svg?alt=media&#x26;token=61be5bf3-7235-45fe-af5f-726229df8dd6" alt="" data-size="line">  File upload</summary>

Selecting the **file upload** option prompts you to select a file:

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F0a4z2HPl2DAFPH8IDoUY%2FPostman%20importer%203a.png?alt=media\&token=3e09fa3b-5570-4349-9e16-1c6bc4b1b065)

Click the **choose file** button to locate and select the required file on your local or network drive. Once selected, the file is uploaded and the filename is confirmed - for example:

&#x20;![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FiJOvwPnLmyRwhzEpHZOJ%2FPostman%20importer%203c.png?alt=media\&token=fd646438-a1a0-47ae-8461-a0f2d249dc1e)

</details>

<details>

<summary><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FPq80F8deQ3i4P3iazHRj%2Ficon%20decision.svg?alt=media&#x26;token=61be5bf3-7235-45fe-af5f-726229df8dd6" alt="" data-size="line"> URL</summary>

Selecting the **URL** option prompts you to provide a URL:

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FYsuAZllxdZbMrQIkcRga%2FPostman%20importer%203b.png?alt=media\&token=893e9e0a-0bae-4254-8ff8-b360f0362b54)

Enter the full URL to your collection - for example:

&#x20;![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F7YvydRFMXPCXsxFRuGi8%2FPostman%20importer%203d.png?alt=media\&token=cb21ff3b-3e40-47cd-8bd3-ff7231eee490)

</details>

**Step 6**\
Click the **confirm** button:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F0Mzi7BXWgIpBIanMS8y2%2FPostman%20importer%205.png?alt=media&#x26;token=6e81a70d-f9c8-4edd-8c79-1cdee5aeacd7" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
If you toggle ON the **update existing connector?** option, the setup for an existing connector found with the same name will be overwritten. If you leave this option OFF and an existing connector with the same name is found, the import will add a new version alongside the original. If in doubt, leave this option set to OFF.
{% endhint %}

**Step 7**\
The Postman collection is imported and a new connector is added to your list. Any setup that could not be completed is displayed - for example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FB6YInIkOg0DoIBJHZIKF%2FPostman%20importer%206.png?alt=media&#x26;token=d0cc65f2-33d8-4a4f-b7ea-25887e3103f6" alt=""><figcaption></figcaption></figure>

**Step 8**\
You can now edit the connector and add any setup that the Postman importer was not able to complete:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FOgVdXfusqRqczrX57YYc%2FPostman%20importer%207.png?alt=media&#x26;token=05c4f11d-74ac-4720-b88e-a0b05574d9b0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For information on connector setup options please see [Building your own connector](https://doc.wearepatchworks.com/product-documentation/developer-hub/connector-builder/building-your-own-connector).
{% endhint %}