- Introduction
- Installing and updating
- Navigating Postman
- Sending your first request
- Managing your account
- Syncing your work
- Discovering templates
- Creating your first collection
- Creating a workspace
- Setting up your Postman app
- Importing and exporting data
- Troubleshooting app issues
- Building requests
- Authorizing requests
- Receiving responses
- Grouping requests in collections
- Using variables
- Managing environments
- Visualizing responses
- Specifying examples
- Using cookies
- Working with certificates
- Generating client code
- Troubleshooting requests
- Using the Collection Runner
- Scheduling runs with monitors
- Building request workflows
- Importing data files
- Working with your team
- Defining roles
- Requesting access
- Sharing your work
- Your private API network
- Commenting on collections
- Versioning APIs
- Using version control
- Using the API Builder
- Managing and sharing APIs
- Validating APIs
- Monitoring APIs
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- Monitoring FAQs
- Analyzing with reports
- Documenting your API
- Authoring your docs
- Publishing your docs
- Viewing documentation
- Using custom domains
- Publishing templates
- Publishing to the API Network
- Submission guidelines
- Managing your team
- Purchasing Postman
- Billing
- Configuring team settings
- Utilizing audit logs
- Onboarding checklist
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Microsoft AD FS
- Custom SAML in Azure AD
- Custom SAML in Duo
- Custom SAML in GSuite
- Custom SAML in Okta
- Custom SAML in Onelogin
- Custom SAML in Ping Identity
- Migrating to the current version of Postman
Using Run in Postman buttons
The Run in Postman button is a way to give users direct access to your API endpoints. When you create a button for your collection, you can embed the button in your website or API documentation. When users click your button, a copy of your collection will open in Postman.
Dynamic and Static buttons
There are two types of Run in Postman buttons:
Dynamic button: This button uses HTML and CSS, and is optimal for a website. The dynamic button also gives you access to the Run in Postman API.
Static button: This button uses Markdown, and is optimal for a Markdown document like a GitHub ReadMe or BitBucket repository.
With both buttons you have the option to include an environment in the button. The environment will be imported into Postman along with a copy of your collection whenever a user clicks your button.
User interaction with your button
When a user finds your button displayed on your website and they click it, they'll be prompted to open the Postman app. If they haven't downloaded the app yet, they'll have the option to do so then.
If the button is dynamic, the prompts will open for the user in a modal, like the screenshot above (above modal is specific to Macs). If the button is static, the prompts will open for the user in a new page.
A copy of your collection will be imported into the user's app, and the app will open on the user's desktop.
Security considerations
This section only covers security details related to the Run in Postman feature. Refer to the complete security practices page for general details.
- Do a test import of your collection to be sure no sensitive data, like access keys, has been included. You can create a duplicate of your collection and remove any data you do not want shared. Duplicate your collection from the ellipsis (...) menu next to your collection name.
- Collections imported into Postman via the Run in Postman button are copies of the original.
- Only collection-specific data you enter in Postman is shared through the Run in Postman button. Examples of collection-specific data would include the collection name and description, or request data (URL, headers, body, tests, scripts, etc.).
Next steps
Create a Run in Postman button.