Using the Run in Postman button

Developer experience with Run in Postman

When the developer goes to your API documentation, they will see the Run in Postman button. Below is an example of what the button could look like. Check out other examples.

example run in postman

When they click the Run in Postman button, they will see some options to import the shared collection. The options will display in a modal if you implemented the button using JavaScript, or a new page if you implemented the button using a static image.

 import options

If the developer selects one of the first two options, either the Postman Chrome app or Postman Mac app, the collection will be directly imported to their Postman app and bring the app into focus.

user has postman

If the developer selects the third option, for people who do not yet have the Postman app, they will be directed to the web view to either download a file of the collection or get the Postman app. Nothing will happen if someone without the app clicks on the first two options. 

user does not have postman