Waiting for engine...
Skip to main content

OpenAPI 3.0

OpenAPI 3.0 (formerly Swagger Specification) is an API specification available for Boomi Enterprise Platform and Partner REST APIs within the service.

The OpenAPI 3.0 Specification (OAS) enables clients to more easily use and understand 's REST APIs. Because of its language-agnostic interface, clients can use the OpenAPI specification (OAS) with common API tools to programmatically discover available Boomi Enterprise Platform API and Partner API endpoints. Users can also generate sample requests and responses based on a refined schema and more easily explore and test APIs using common tooling without needing to reference complex code or additional help documentation. The ease and accuracy of OAS documentation also allows you to detect defects early in your development cycle and alleviates strain on your continuous integration pipeline.

If you find that you need additional information about a particular API after using OAS, descriptions of each available API object and action are in the Help documentation. For example, if you want to know what a particular attribute or element represents in an API's request or response.

Using OAS with common API tools​

You can easily access OpenAPI 3.0 documentation for Integration's platform and Partner APIs using any tool of your choosing, such as Postman. Use the following general instructions to import the available Boomi Enterprise Platform API and Partner API collection to your specific tool:

  1. Open an API tool, such as Postman.

  2. Click File > Import.

  3. Click the Link tab.

  4. From your API tool, do one of the following:

    a. To make calls to a Boomi Enterprise Platform API, copy and paste https://api.boomi.com/api/rest/v1/<atomsphere_account_ID>/openapi.json into the URL field.

    b. To make calls to a Partner API, copy and paste https://api.boomi.com/partner/api/rest/v1/<atomsphere_account_ID>/openapi.json into the URL field where <atomsphere_account_ID> is the account ID.

  5. Replace <atomsphere_account_ID> in the URL with the ID of the authenticating account from which you want to make requests.

  6. Click Continue.

  7. Under Show Advanced Settings, optionally change the Folder Organization selection to Tags.

  8. Click Import. This actions adds Boomi Enterprise Platform APIs or Partner APIs to your collection.

  9. Open the Collections tab of your tool and select your new collection, titled either Boomi Enterprise Platform API or Partner API. From here, you can enter your credentials to globally apply authentication to all requests within that collection.

    a. Under the Authorization tab, select Basic Auth as the authentication type and enter your sign-in credentials.

    b. If you are using a Boomi Enterprise Platform API token instead, enter BOOMI_TOKEN.<your_AtomSphere_user_name> in the Username field and the API token in the Password field.

    note

    You must use an API token if you enable your account with two-factor authentication (2FA) or single sign-on (SSO).

    c. If you want to grant different account permission to the collection, change the values of the Username and Password fields in the Authorization tab. Then, under the Variables tab, modify the CURRENT VALUE field with the new account ID.

  10. In your new collection, you can see the list of available APIs and expand them to view their available operations.

  11. Test out an API object and configure URL and request parameters as appropriate. Click Send and view the results.

On this Page