Importing Postman Collections, Variables, and Environments

If you have a Postman API Collection, you can import it directly into API Testing on Sauce Labs and use it to generate tests.

What You'll Need

• A Sauce Labs account (Log in or sign up for a free trial license).
• An existing API Testing Project. For details on how to create one, see API Testing Quickstart.
• A Postman Collection (v2.0 or higher).

note

Looking to import from a spec file? See Building a Test from a Spec File.

Importing Postman Collections

1. Log in to Sauce Labs, then click API Testing.
2. Click to open one of your Projects.
3. Click the HTTP Client tab.
   
4. Click the Import OpenAPI/HAR/Postman button, then select and upload your Postman Collection file from your local machine.
   

tip

If you don't have a file available, try out the sample below.

Click here to open sample Postman Collection file

Copy the text below, paste text into a text editor, then save that as a .json file.

demo_postman_collection.json

{
"info": {
"_postman_id": "901ae894-37d4-45c1-b1bc-bd6b31762bfe",
"name": "demoapif",
"description": "Call to the APIF demo API All Products Get.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "product",
"item": [
{
"name": "List All Products",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "addTokenTo",
"value": "header",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "key",
"value": "ABC123",
"type": "text"
}
],
"url": {
"raw": "http://demoapi.apifortress.com/api/retail/product",
"protocol": "http",
"host": ["demoapi", "apifortress", "com"],
"path": ["api", "retail", "product"]
}
},
"response": []
}
],
"description": "Folder for product"
}
]
}

5. Click the folder your Snapshots tree where you'd like to save your file.
   
6. Click Save.
   
7. The routes from your collection will now show in the list of saved requests.
   

Importing Postman Environments

1. Log in to Sauce Labs, then click API Testing.
2. Click to open one of your Projects.
3. Click the Vault tab.
   
4. Click Variables.
   
5. Click Import.
   
6. Select and upload your .postman_environment.json file.

Your environmental variables will now be available in the Variables section of your Project.

Importing Postman Variables

1. Log in to Sauce Labs, then click API Testing.
2. Click the Company Vault tab.
   
3. Click the Variables radio button.
   
4. Click Import.
5. Select and upload your .postman_environment.json file.

Your environmental variables will now available across all your Projects.

Importing a HAR File (RDC and VDC)

You can import a HAR (HTTP Archive) file into API Testing to automatically generate a functional test. Network Traffic Capture and Extended Debugging must be enabled to use this feature. See Network Traffic Capture and Enabling Extended Debugging for more information.

To import a HAR file:

1. In Sauce Labs, click API Testing.

2. On the Projects page, under the project you want to import the file to, click HTTP Client.

3. On the HTTP Client page, click Import OpenAPI/Postman, and then click Import Har from RDC Job or Import Har from VDC Job.

4. In the Import Snapshots window, click a test in the list and then click Import. You can filter this list by job owner or job type.

5. In the Snapshots panel, navigate to a folder and then click Save.

6. When the import is complete, in the Snapshots panel, open the folder you imported the files to.

7. In the folder, click on a snapshot to view its details in the response panel.

8. To create a test based on the imported file, click Generate Test. For more information about creating a test, see Create a Test.

More Information

• Build a Sauce Labs API Test from a Spec File
• Importing and Exporting Data from Postman