Integrate Postman with APIMatic

Postman's APIMatic integration converts a Postman Collection into an API description format such as Swagger, RAML, or API Blueprint, and then periodically backs up the resulting file on GitHub.

Prerequisites

To set up an APIMatic integration with Postman, you will need:

• An APIMatic account
• An API in your APIMatic account. You must create or import your API before beginning.
• An APIMatic integration key
• A GitHub account
• A GitHub repository to back up your collection

Configuring an APIMatic integration

1. From the Home page, select Integrations.

   

2. Select Browse All Integrations.

3. Search and select APIMatic.

4. Select Add Integration.

   

5. Your browser will open a new Authorize Postman page that gives Postman access to your GitHub repositories. Select Authorize for one of your GitHub repositories. Once the authorization process is complete, the page will tell you to close the tab and continue in Postman.

   If you aren't signed in to GitHub, you will be prompted to sign in.

6. Enter the following in the Add Integration window:

   • APIMatic API Key - Your APIMatic integration key.
   • Nickname - A nickname for the integration.
   • Workspace - The workspace that has the collection you want to back up.
   • Collection - The collection you want to back up.
   • Repository - The GitHub repository you want to back up your collection to.
   • Directory - The directory in the GitHub repository to back up your collection to. If a directory with that name doesn't exist, it will be created when you add the integration.
   • Filename - A filename for the collection backup file.
   • Format - The format the collection is saved as.
   • Branch - The name of the GitHub branch to back up the collection to. This branch must already exist, and the integration process will fail if you specify an invalid branch name.

7. Select Add Integration.

Once the integration is created, select it to view details about the integration including its run log.

Postman checks your collection for changes. If Postman identifies changes when it checks your collection, the changes automatically commit to your repository in JSON format.

You can view your configured integrations on the Browse Integrations page. You can also view integrations that have been configured for a collection by opening the collection and selecting the information icon in the right sidebar. Learn more about viewing or editing integrations.