Waiting for engine...
Skip to main content

Getting started with Boomi Platform APIs

The Boomi Platform REST APIs provide programmatic access to the Boomi Enterprise Platform functionality. Use the API to manage objects associated with your account, such as components, processes, environments, atoms, deployments, and account configurations.

This topic walks you through making your first API request in Postman, including setting up authentication and verifying credentials.

Prerequisites​

Before you use the Platform APIs, ensure you have the following:

  • A Boomi Platform account with the API Access privilege (included in the Administrator role by default). For more information on user roles and privileges, refer to the User roles and privileges topic.
    note

    You can also use a Boomi Platform Trial account with the Administrator role. For more information, refer to the Boomi Trial Account topic.

  • A valid Boomi API token (recommended) or JWT token.
  • A Postman account (web or desktop application).

Getting your account ID​

Your account ID is required for all API requests. It forms part of the base URL for API endpoints.

To get your account ID, complete the following steps:

  1. Log in to the Boomi Platform.
  2. Go to Settings > Account and click the Account Information tab.
  3. Copy the Account ID (for example, boomi_user-123AZU).
tip

Keep this value handy as you need it for API requests and Postman configuration.

Authentication​

Boomi Platform APIs support Basic Authentication (username and API token) and JWT token authentication. The authentication method depends on the specific Boomi API you are using. For more information, refer to the Platform API and Partner API authentication topic.

tip

For getting started, use Basic Authentication with your API token. It is the simplest method and works with all Boomi Platform APIs.

Calling your first Boomi API request​

All Platform API requests use the base URL https://api.boomi.com/api/rest/v1/{accountId}.

To get started, click Run in Postman from any Boomi API reference topic to fork the collection, then configure authentication using either Basic Authentication (username and API token) or JWT token authentication.

Example for Basic Authentication:

  • Username: BOOMI_TOKEN.john.doe@boomi.com
  • API token: 1a2b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6

Run In Postman

For detailed instructions on forking and configuring the collection, refer to the Working with Boomi APIs on Postman topic.

Example: Calling a GET request​

This example retrieves a specific component from your Boomi Platform account.

How to obtain a componentId (required)

To get a component ID for testing, you need to create a component in the Boomi Platform. Click the Integration service, navigate to the Build page in Component Explorer, create a component, and copy the componentId. For information about creating components and viewing the componentId, refer to the Creating Components and Components Revision History dialog topics. For API reference details, refer to the Component.

To call a GET request, complete the following steps:

  1. In Postman, expand the forked collection and navigate to the Component folder.

  2. Click the GET Component request.

  3. Replace {componentId} in the endpoint URL with a component ID you obtained from the Component Explorer. For example: https://api.boomi.com/api/rest/v1/{{accountId}}/Component/2bb3a8ce-32f5-45cb-a2e3-d29d693c8724

  4. Click Send to execute the request.

If your credentials are correct, you receive a 200 OK response with the component details in XML format. This confirms your setup is working correctly.

Advanced query and bulk operations​

In addition to GET, CREATE, and UPDATE, Platform APIs support advanced operations for filtering, pagination, and bulk processing:

  • QUERY - Apply filters to customize query results
  • QueryMore - Retrieve paginated results when queries return more than 100 records
  • Bulk operations - Retrieve or update multiple objects in a single request

For more information, refer to the Query filters, Query paging, Bulk GET operations, and Bulk UPDATE operations topics.

Additional information​

  • Boomi enforces rate limiting on the API. For information, refer to the API usage limits topic.

  • API responses include HTTP status codes to indicate success or failure. For more information on the status and error codes, refer to the Boomi API errors topic.

  • Use a valid time zone ID for objects requiring a time zone in the Boomi Enterprise Platform API. For more information on the supported time zones, refer to the Valid Time Zone topic.

Troubleshooting common issues​

If you encounter errors while using the Boomi Platform APIs, refer to the Common Boomi Platform API Errors topic for detailed troubleshooting guidance.

Best practices​

  • Ensure your user account has the API Access privilege and appropriate object-level permissions
  • Use API tokens instead of passwords for better security
  • Organize related requests into Postman collections for better management and reusability
  • Verify that component IDs, runtime IDs, and other resource identifiers exist before making API calls
  • Confirm that the API object supports your intended operation (GET, QUERY, CREATE, UPDATE) before making the request
  • Limit your requests to 10 per second to avoid throttling
  • Ensure your XML or JSON payloads are properly formatted and use correct field names before sending requests
On this Page