Waiting for engine...
Skip to main content

Working with Boomi APIs on Postman

Postman is a widely used API client that helps you explore, test, and troubleshoot APIs. This article explains how to get started with Boomi REST APIs using Postman.

note

Postman is a third-party tool. Boomi does not provide support for Postman itself. For tool-specific guidance, refer to the Postman documentation.

Prerequisites​

Before you begin, make sure you have:

  • Access to a Boomi account with the required API permissions
  • A valid Boomi API token, OAuth access token, or relevant access
  • A Postman account (web or desktop)

Postman collections​

Postman organizes API requests into collections, which are stored in workspaces. You can add Boomi APIs to Postman by importing an OpenAPI specification or by forking a shared collection.

Using a local copy of a collection allows you to:

  • Send API requests to Boomi endpoints
  • Configure authentication and environment values
  • Customize requests without affecting the original source

Adding Boomi APIs by forking a shared collection​

Boomi API collections are available through Run in Postman links on the API Overview topics and individual API reference topic in the Boomi Developer Documentation.

Run in Postman

When you click Run in Postman, Postman opens the collection and prompts you to fork it into your workspace. You can review the collection structure and requests before completing the fork.

Fork collection

Forking creates a copy of the collection that you own. This allows you to configure authentication, update variables, and customize requests, while still being able to pull in updates when the original collection changes.

Fork settings

Updating a forked collection​

Shared collections may be updated to reflect new endpoints, improvements, or deprecated functionality.

To pull updates into your fork:

  1. Select the collection’s More actions menu.
  2. Click Pull changes.
  3. Review the changes and apply them.

Configuring a collection​

Before sending requests, configure authentication and any required account-specific values for the collection.

Authorization on Postman collections​

Boomi APIs support multiple authentication mechanisms, depending on the API. For details on supported authentication methods and when to use them, refer to the relevant Boomi API Reference topics.

  1. Open the collection settings in Postman.
  2. Select the Authorization tab.
  3. Choose the appropriate authorization type for the API you are using.
  4. Provide the required credentials or tokens.
  5. Save the configuration.

Authorization settings

Variables​

Collections use variables to define values such as the API base URL and account ID.

  1. Open the collection settings.

  2. Go to the Variables tab.

  3. Set current values for required variables.

    For example:baseUrl, accountId, userName, password

  4. Persist the values and save.

Variable settings

Sending API requests​

Once configured, you can start making API calls.

  1. Expand the collection and select an endpoint.
  2. Review the request method and URL.
  3. Provide any required path or query parameters.
  4. Add a request body if the operation requires one.
  5. Click Send.

First API request

The response appears below the request, including status, headers, and body.

On this Page