# Integrate Postman with CircleCI

CircleCI is a cloud-based continuous integration and continuous delivery (CI/CD) platform. Software development teams use CircleCI to run build jobs, automate tests, and orchestrate complex workflows.

To set up CircleCI integration for your API in the Postman API Builder, first create an API token in CircleCI and then configure your API in Postman. After you set up the integration, you can view the status of builds or start a new build, all from within Postman.

## Creating a CircleCI API token

1. Sign in to [CircleCI](https://app.circleci.com/settings/user/tokens) and go to **User Settings > Personal API Tokens**.
2. Click **Create New Token**.
3. Enter a **Token Name** and click **Add API Token**.
4. Click **Copy** to copy the new token. (Save the token somewhere safe.)

## Configuring a CircleCI integration

1. Open your API by selecting **APIs** in the sidebar. *Each API can be linked to one CI project*.
2. Click **Test and Automation**.
3. Under **Automate**, select **CircleCI**.
4. Enter a **Nickname** to help you recognize the integration later.
5. For **API Key**, enter your CircleCI token.
6. Select the **CI project** used for your API.
7. Click **Connect**.

<img alt="Connect to CircleCI" src="https://assets.postman.com/postman-docs/v10/circleci-connect-project-v10.jpg" />

## Viewing build status

After you set up a CircleCI integration, status information for build jobs is available in Postman. For each build you can view the commit message, the branch the build ran on, the start time and duration, and the build status (`Success` or `Failed`).

To view build jobs, open an API and click **Test and Automation**. The most recent jobs are listed under the repository name.

Click **View All Builds** to view the full list of build jobs. From here you can take the following actions:

* Use the dropdown lists to filter jobs by branch or build status.
* To open a build in CircleCI, select the build name.
* To start a new build, click **Run Build**. Select or enter the name of the branch to use and select **Run Build**.
* To get the latest build status information, click <img alt="Refresh icon" src="https://assets.postman.com/postman-docs/icon-refresh-v9-5.jpg#icon" width="14px" /> **Refresh**.
* To edit or delete the integration, click the more actions icon <img alt="More actions icon" src="https://assets.postman.com/postman-docs/icon-more-actions-v9.jpg#icon" width="16px" />.

<img alt="View all CircleCI builds" src="https://assets.postman.com/postman-docs/v10/collection-runs-v10-16-2.jpg" />

## Viewing collection run details

Using the Postman CLI, you can run Postman collections with your API tests as part of a CircleCI pipeline.

To view details for collections that were run as part of a build, first [configure the Postman CLI for CircleCI](#configuring-the-postman-cli-for-circleci) and then [start a new build](#viewing-build-status). After the build is complete, use the arrows to expand a build and expand a collection to view details about a collection run.

<Info class="iconless-callout">
  Click **View Report** to view a collection run report in the Postman **History**. Learn more about using the [Collection Runner](/docs/collections/running-collections/intro-to-collection-runs/).
</Info>

## Viewing API Governance and API Security rule violations

Using the Postman CLI, you can enforce [Postman API Governance and API Security rules each time the pipeline runs](/docs/api-governance/api-definition/api-definition-warnings/#track-governance-and-security-rule-violations-in-cicd) using the [api lint](/docs/postman-cli/postman-cli-options/#governance-and-security) command ([Enterprise teams only](https://www.postman.com/pricing/)).

To view the results of API Governance and API Security checks that ran as part of the build, first [configure the Postman CLI for CircleCI](#configuring-the-postman-cli-for-circleci) and then [start a new build](#viewing-build-status). After the build is complete, use the arrows to expand a build and expand an API specification stored in the Postman API Builder to view any rule violations.

<img alt="View API Governance and API Security results" src="https://assets.postman.com/postman-docs/v10/api-governance-and-security-results-v10-16.jpg" />

## Configuring the Postman CLI for CircleCI

With the help of the Postman CLI and the Postman API, you can run Postman collections with your API tests as part of your CircleCI pipeline. First generate the Postman CLI configuration code in Postman. Then add the configuration code to the `config.yml` file in your CircleCI project.

You can also enforce [API Governance and API Security rules](/docs/api-governance/api-definition/api-definition-warnings/#track-governance-and-security-rule-violations-in-cicd) each time the pipeline runs ([Enterprise teams only](https://www.postman.com/pricing/)).

To generate configuration code for the Postman CLI, do the following:

1. Open your API and click **Test and Automation**.
2. Under the repository name, select **View All Builds**.
3. Click **Configure Postman CLI**.
4. Select a **Collection** to run during pipeline builds. To be available in the dropdown list, you must first [add the collection as a test suite](/docs/design-apis/api-builder/testing-an-api/#adding-api-tests) to your API in the Postman API Builder. You can also select an **Environment** to use.
5. (Optional) Select the checkbox to enforce API Governance and API Security rules each time the CI/CD pipeline runs ([Enterprise teams only](https://www.postman.com/pricing/)).
6. Select the **Operating system** for your CI/CD pipeline.
7. Click **Copy Postman CLI Command** to copy the Postman CLI configuration.

<img alt="Generate the Postman CLI configuration" src="https://assets.postman.com/postman-docs/v10/generate-postman-cli-v10-3.jpg" />

To add the Postman CLI configuration to your CircleCI project, do the following:

1. Open your project in CircleCI, select a branch, and then click **Edit Config**.

2. Paste the Postman CLI configuration you copied from Postman. Then, do the following:

   * Replace all instances of `$POSTMAN_API_KEY` with a valid [Postman API Key](/docs/developer/postman-api/authentication/#generate-a-postman-api-key).
   * Make sure to add the `postman-automated-runs` job to a new or existing workflow.

3. Click **Save and Run** to run the pipeline using the new configuration.

4. To view the test results in Postman, open your API and click **Test and Automation**.