Waiting for engine...
Skip to main content

API connectors

The Boomi Enterprise Platform API connector and Boomi Enterprise Platform Partner API connector enable you to perform API object-based operations and actions within your integration processes.

The design of the API connectors connect seamlessly with the Platform. Integrating with the platform consists of web service calls utilizing a SOAP request and response setup over an HTTPS connection. The technical details of this connection, such as request headers, error handling, and HTTPS connection, are all abstracted to simplify your implementation.

The object-based operations and actions available in the Boomi Enterprise Platform API connector and Boomi Enterprise Platform Partner API connector are the same as those in the equivalent API.

Using an API connector in an integration process can make working with the underlying API easier. The API connectors:

  • Allow you to select from a list of available objects and actions.

  • Provide an expression builder for creating query filters.

  • Handle query paging for you by using the queryMore token automatically. As a result, the API connectors do not limit the number of records returned by a Query request.

  • Detect API response errors automatically, and either fail a document or set the Application Status Code document property accordingly.

  • Handle HTTP 503 Service Unavailable errors automatically by retrying a request up to five times. HTTP 503 errors can result from an account exceeding its API usage limit, such as five requests per second. Retrying the request at a different time might resolve the issue.

note

Deploying a Boomi Enterprise Platform API connector or Boomi Enterprise Platform Partner API connector does not affect your license count. You can deploy these API connectors unlimited times across different Runtimes and environments.

The Boomi Enterprise Platform Partner API connector, like the Partner API itself, provides Boomi Enterprise Platform partners with programmatic access to the subaccounts that they manage. As a partner, you can override the account to which a request applies by defining a process property called boomiPartnerApi-overrideAccountId in the connector operation.

For the following API operations, use the Boomi Enterprise Platform Partner API connector rather than the Boomi Enterprise Platform API connector:

  • Account Group operations
  • Account Group Account operations
  • Account Group User Role operations
  • Cancel execution operation
  • Provision Partner Customer Account operation