Postman

Use ReadMe’s Postman integration to automatically sync your Postman collections and keep your API documentation up-to-date alongside your API. This integration transforms your Postman collections into interactive documentation with dynamic code samples for a better developer experience.

You can also deploy collections directly to ReadMe, making them accessible to developers as part of your API Reference. Additionally, ReadMe allows you to fork Postman collections from within docs, enabling developers to explore and test your API in their own Postman workspace.

Deploy Postman Collections to ReadMe

Install the ReadMe app in Postman

⚠️

Note: You'll need to be a Postman admin in order to install this app. Then, you can configure it for your team members to use.

1. In your ReadMe project, go to Settings > Integrations > Postman click "Generate Postman API Key".

2. In your Postman workspace, install the ReadMe app from the Postman App Directory.

   1. At the "What will Readme be able to do?" page in Postman click "Allow".
   2. Input the Postman API Key generated in ReadMe as the Application Secret and click "Next".
   3. Input the Client ID and Client Secret in Postman into the ReadMe Postman form and click Connect to Postman. If the connection is able to connect, click "save" in ReadMe.
   4. Click "Continue" in Postman. Postman will validate that they are able to connect to ReadMe. If successful, you should see a message of "Installation successful!" and you're all set.

3. Sync Collections to ReadMe

   Once connected, select which Postman collections you want to sync to your documentation and push it to your developer portal.

Fork a Postman Collection from ReadMe

ReadMe includes a Try It Now feature that enables users to send live API requests directly from the browser, helping them quickly receive their first 200 OK response.

For developers who prefer to manage all API testing in a single place, you can add a Run in Postman button to your docs. This allows users to instantly fork your API's Postman Collection, making it easy to try endpoints and test requests.

This button is a custom component that you can add directly into your docs.

<PostmanRunButton 
  collectionId="123456-abcd-efgh-ijkl" 
  collectionUrl="entityId=123456-abcd-efgh-ijkl&entityType=collection&workspaceId=abcdef-1234-5678"
/>