Dell Boomi AtomSphere

AtomSphere API

The AtomSphere API is intended to add programmatic access to functionality that is normally accessed through the AtomSphere UI.

NOTE:

The AtomSphere API connector facilitates access for AtomSphere processes to most API operations and actions. Exceptions are noted in the API objects and actions topics.

NOTE:

For information about the Partner API and how it differs from the AtomSphere API, see the Partner API topic linked below.

The AtomSphere API is built around an Object/Verb hierarchy. The Verbs are the various operations (GET, UPDATE, etc) which can be executed for each Object (Account, etc) in the AtomSphere API. This is a parallel to the basic Object Oriented Programming paradigm as well as the web service implementation theory behind REST. The Object/Verb hierarchy will be referred to in terms of Object-based Operations. Those "verbs" that don't fall into this Object/Verb hierarchy (executeProcess, deployProcess, etc) are designated as Actions in the AtomSphere API.

All AtomSphere API calls are authenticated using a user name and an Account ID. This Account ID is utilized as the general context for any API call. For example, in an API call to execute a QUERY of the Account Groups object, if you do not supply any query filters, all of the Account Groups owned by the authenticated Account will be returned.

The AtomSphere API has been developed with both a SOAP and RESTish implementation. Follow the links below in the Object-based Operation and Action sections to find out detailed information about performing each API call using both the SOAP and RESTish implementations.

SOAP API

The SOAP API's WSDL is located at https://api.boomi.com/api/soap/v1/{accountID}?wsdl where accountID is your AtomSphere Account ID. The WSDL is protected by Basic Authentication so your AtomSphere user name and password will be required to access it. Each SOAP call is protected by WS-Security using a UsernameToken where the password is passed as PasswordText.

RESTish API

The RESTish API calls all begin with https://api.boomi.com/api/rest/v1/{accountID} where accountID is your AtomSphere Account ID. The rest of the URL is dependent upon the operation you are trying to perform. The full URLs are discussed in the documentation for each Object-based Operation and Action. The RESTish calls are protected by Basic Authentication.

The schema used by the RESTish API is the same as the one used by the SOAP API. The schema is located at https://api.boomi.com/api/soap/v1/{accountID}?xsd=1 and is protected by Basic Authentication.

API Usage Request Limit

Both the SOAP and RESTish implementations of the API limit the number of requests that can be served per day. The limit is account specific. Each account’s usage request limit is calculated as 1000 times their number of licensed connectors. Usage is calculated based on a rolling 24 hour period with usage calculated every hour. If usage of the API exceeds this limit, the user will receive an HTTP 503 response indicating that the server is temporarily unable to fulfill the request.

To provide a simple example of how this works, assume that an account has a limit of 200 requests per day. If, starting at noon on Monday, the account makes 10 requests per hour, the account will reach it's limit of requests per rolling 24 hour period during the 7am hour on Tuesday (20hrs * 10 requests/hr = 200 requests). The user will not be able to make requests again until the previous 24 hour period has fewer than 200 requests. This will not happen until noon on Tuesday, when the previous days requests from the noon hour fall out of the previous 24 hour period.

NOTE:

None of AtomSphere’s built-in functionality uses the API, so it does not affect the customer’s API usage limit.

API Usage Rate Limit

Both the SOAP and RESTish implementations of the API limit the rate of requests to five requests per second. If usage of the API exceeds this limit, the user will receive an HTTP 503 response indicating that the server is temporarily unable to fulfill the request.

Related References