Waiting for engine...
Skip to main content

Test your API

Before you build automation around a Boomi API, test your calls interactively to confirm your credentials, endpoint, and payload are correct.

Test using Postman​

Most Boomi API reference topics include a Run in Postman button that forks a ready-to-use collection into your workspace.

To test an API call in Postman:

  1. Click Run in Postman on the relevant API overview or reference topic to fork the collection.
  2. Open the collection's Authorization tab and configure the authentication method for your service area. Refer to Authenticating your API.
  3. Open the Variables tab and set values such as baseUrl and accountId.
  4. Select a request, provide any required path, query, or body parameters, and click Send.
  5. Review the response status, headers, and body.

For complete setup instructions, refer to Working with Boomi APIs on Postman.

Test using Swagger​

Some service areas, such as MFT, provide an interactive Swagger page per region (US, UK, EU, or AU) where you can authorize and execute requests directly in the browser:

  1. Open the Swagger page for your region.
  2. Click Authorize and provide your token or API key.
  3. Expand an endpoint, click Try it out, edit the request, and click Execute.
  4. Review the curl command, request URL, response body, and response headers Swagger generates.

Verifying the response​

A successful call typically returns an HTTP 2xx status code:

  • 200 - The request succeeded.
  • 202 - The request is processing asynchronously; you may need to poll for the result.
  • 204 - The request succeeded, but there is no content to return.

If you receive a 4xx or 5xx status code, check your credentials, account ID, request format, and rate limits.

Troubleshooting common issues​

If your API requests fail with authentication or authorization errors (such as 401 or 403), verify that your credentials, account ID, and permissions are correct, and confirm you are using the correct base URL for your region.

For a complete list of status codes and error responses, refer to API errors.

Next steps​

Once your calls succeed, refer to Find the right API to identify which service area and operations best fit your use case.

On this Page