install-with-app.md

Back to main page

Instructions updated for Postman desktop app v8

Installing with the Postman Desktop App

This is the recommended installation option because it is the fastest to set up and doesn’t require changes on your Salesforce org.

🎥 Video instructions

• Install the Postman App
• Fork the Collection
• Configure the Collection
• Authenticate with Salesforce
• Execute a Request

Install the Postman App

Download and install the Postman app from this link.

Fork the Collection

1. In the Postman desktop app, click on the top search bar and type Salesforce.

2. Click Salesforce Developers under Teams.

   

3. Under Collections click the Salesforce Platform APIs entry.

4. Click Fork in the top right.

   

5. Enter a label for your fork (e.g.: “My fork”).

6. Select a workspace (the default “My Workspace” workspace is fine).

7. Click Fork Collection.

Configure the Collection

1. Click Salesforce APIs

2. Open the Variables tab.

3. If needed, update the CURRENT VALUE of the url variable with your org's My Domain login URL in one of these formats:

   • https://MyDomainName--SandboxName.sandbox.my.salesforce.com for sandboxes or Scratch orgs.
   • https://MyDomainName.my.salesforce.com for production, Trailhead Playground and Developer Edition orgs.

4. Click Save.

Authenticate with Salesforce

You'll need to authenticate with Salesforce to access the APIs. Doing so grants you an access token that is valid for a certain duration.

Repeat this step whenever your access token expires.

1. Click Salesforce APIs

2. Open the Authorization tab. The authorization type should be set to OAuth 2.0.

3. Click Get New Access Token. This opens a browser tab with the Salesforce login screen.

4. Log in to your Salesforce org.

5. Click Allow to grant access to "Salesforce APIs Collection for Postman" to your org.

   

   At this point, if your environment is correctly set up, you should see a success message and you should be redirected to the Postman app.

   If the redirection doesn't happen, you may need to authorize popups in your browser.

   Click here for instructions on how to authorize popups.

   Note: these instructions are for Chrome but the steps should be similar with other browsers.

   1. Click the popup error in the address bar, choose to allow popups from Postman:

      

   2. Refresh the page and allow the browser to open the Postman app:

      

6. Copy the value of the instance_url field from the token details view. Make sure not to copy the line break character.

   

7. Click Use Token.

8. Open the Variables tab.

9. Update the CURRENT VALUE of the _endpoint variable with the value that you just copied from the instance_url field in the access token details.

10. Click Save.

Execute a Request

1. Expand the collection and select the REST > Limits request.
2. Click Send.

At this point, if your environment is correctly set up, you should see a 200 OK status. This means that you have successfully authenticated with Salesforce and that you can now use the other collection’s requests.

See additional documentation for more information on how to keep the collection up to date and work with multiple Salesforce orgs.

Back to main page