Waiting for engine...
Skip to main content

Boomi Platform APIs

The Boomi Platform API provides programmatic access to the Boomi Enterprise Platform functionality.

The API is built around an object/verb hierarchy. This hierarchy parallels the basic object-oriented programming paradigm as well as the web service implementation behind REST.

  • Objects represent structures and relationships within the Enterprise platform, such as Account, Account User Role, Atom Startup Properties, and Environment.

  • Verbs are the operations performed for each object, such as GET, QUERY, and UPDATE. These verbs are object-based operations. Verbs that do not fall into the object/verb hierarchy, such as executeProcess, are action-based operations.

All Platform API calls use an API token or user name for authentication and an account ID associated with an active account. For any API call, the account ID is the general context. For example, suppose you make an API call to run a QUERY of the Account Groups object without applying query filters. In that case, the query returns all account groups owned by the authenticated account. If you are using single sign-on, you need to use an API token to authenticate.

Boomi developed the API RESTish and SOAP implementations.

note

Integration also provides:

  • The Platform Partner API, which supports additional partner-specific operations.
  • The Platform API and Platform Partner API connectors, which enable you to perform API object-based operations and actions within your integration processes.

Implementation​

Platform REST API Reference

Platform Partner REST API Reference

All RESTish API endpoint URLs begin with the prefix:

https://api.boomi.com/api/rest/v1/{accountID}

where accountID is your account ID. The complete endpoint URL depends on the operation you are trying to perform. The description of each associated API object-based operation provides complete URLs in addition to action topics within this Help guide.

info

Integration-specific Boomi Enterprise Platform API and Partner REST APIs are also available from the OpenAPI 3.0 specification. Because OpenAPI 3.0 is language agnostic, it enables users to easily discover available Integration API and Partner API objects and actions, test requests and responses, and understand the API's functionality. For more information, refer to the topic OpenAPI 3.0.

HTTP Basic Authentication protects RESTish requests, requiring either your Boomi Enterprise Platform API token or user name and password credentials.

Request and response bodies for RESTish requests are XML by default. The XML schema, which is the same for both the RESTish API and the SOAP API, is located at:

https://api.boomi.com/api/soap/v1/{accountID}?xsd=1

You can use JSON-formatted request bodies in RESTish calls by sending the request with the HTTP header Content-Type: application/json. To receive JSON-formatted responses, send the request with the HTTP header Accept: application/json.

You can configure CORS (Cross-Origin Resource Sharing) request matching rules for your account to enable cross-server, JavaScript-powered RESTish requests.

API usage limits​

Both the REST and SOAP implementations of the Boomi Enterprise Platform API enforce the following usage limits:

Rate of requests per second
The limit is 10 requests per second.

If API usage exceeds this limit, API users receive an HTTP 503 response indicating that the server is temporarily unable to fulfill the request.

note

None of the built-in functionality uses the API, so using the Enterprise platform does not affect your API usage limits.

The Boomi Enterprise Platform API connector and the Partner API connector handle HTTP 503 errors automatically by retrying a request up to five times.

On this Page