(888) 685-3101 ext. 2

This article is a detailed tutorial on exposing RESTful webservice using Boomi API management.

Dell Boomi API Management

Dell Boomi API Management feature enables an API publisher to expose versioned APIs for a logical group of APIs. An API consists of a set of REST, SOAP or OData endpoints. The Dell Boomi APIs are implemented as deployable API components.

Note: The Web Services Server connector, which is available as part of the AtomSphere Services Enablement feature, is the simplest/default method for deploying a web service that can be used in a standalone environment without using the API components. API management can be used for building more robust and advanced web services management. The differences and criteria for choosing between web services server connector and API component can be found at difference between web services server component and API component.

We will be exposing a simple RESTful web service that was built using Web Services Server Connector on Dell Boomi Platform. The blog link for the same can be found at Build RESTful web service on Boomi platform using Web Services Server Connector component.

Modify Shared Web Server API Type setting to Advanced.

1. Login to https://platform.boomi.com/ with your userID and password.

2. Click on Manage -> Atom Management.

Dell Boomi API Management - Expose RESTful Service - Screenshot 1

3. Click on local atom Local_Atom_MG on which you deployed your Hello RESTful web service that was developed. The blog link for the same can be found at Build Synchronous RESTful web service on Boomi Platform

Dell Boomi API Management - Expose RESTful Service - Screenshot 2

4. Click on Shared Web Server.

Dell Boomi API Management - Expose RESTful Service - Screenshot 3

5. Change the API Type to Advanced and click Save.

Note: The available API types options Basic, Intermediate and Advanced. We will be using Advanced type in our example. For more information on the API Types, please visit the API types section in the link Shared Web Server panel.

Dell Boomi API Management - Expose RESTful Service - Screenshot 4

Note : Configuring Basic Authentication settings and adding a user can be found in the blog Enabling Basic Authentication and adding a user.

6. Click Yes, restart plugin now.

Dell Boomi API Management - Expose RESTful Service - Screenshot 5

7. Shared Web Server settings are updated.

Create Hello API Management service.

1. Create a folder API under the Development folder. Create a component under the API folder.

Type – API
Component Name – Hello-API-Service.
API Type – API Service

Click Create.

Dell Boomi API Management - Expose RESTful Service - Screenshot 6

2. Enter the following details under General and Click Save.
Published API Title – Hello API Service
Published API Number – v1Published Description – API Managment service for Hello RESTful service
Base API Path – v1/hello-service

Dell Boomi API Management - Expose RESTful Service - Screenshot 7

3. Click REST. Click on Import an Endpoint.

Dell Boomi API Management - Expose RESTful Service - Screenshot 8

4. Choose Use an existing process and click Next.

Dell Boomi API Management - Expose RESTful Service - Screenshot 9

5. Select Process – Hello and Add to – REST Checked. Click Finish.

Dell Boomi API Management - Expose RESTful Service - Screenshot 10

6. Click on Profiles -> Root. Click on Standardize on this profile under
Profile Name: Hello Input.

Dell Boomi API Management - Expose RESTful Service - Screenshot 11

7. A dialog appears. Click OK.

Dell Boomi API Management - Expose RESTful Service - Screenshot 12

8. Click on View Deployments.

Dell Boomi API Management - Expose RESTful Service - Screenshot 13

9. A dialog box appears. Click Yes.

Dell Boomi API Management - Expose RESTful Service - Screenshot 14

10. Select Local-Dev under Unattached Environments and Click Dell Boomi API Management - Expose RESTful Service - Screenshot 15 to move to Attached Environments.

Dell Boomi API Management - Expose RESTful Service - Screenshot 16

11. Click on Deployments

Dell Boomi API Management - Expose RESTful Service - Screenshot 17

12. Click on Deploy Latest Revision of API Service.

Dell Boomi API Management - Expose RESTful Service - Screenshot 18

13. A Deployment Confirmation dialog appears to add Deployment Notes. Enter Deployment notes and Click OK.

Dell Boomi API Management - Expose RESTful Service - Screenshot 19

14. An entry appears under the API Service Deployment History.

Dell Boomi API Management - Expose RESTful Service - Screenshot 20

Testing the Hello API Service using the Dell Deployed Boomi API Swagger Visualization portal.

1. On the top right corner, click on Integration dropdown and select API Management to Switch to API Management.

Dell Boomi API Management - Expose RESTful Service - Screenshot 21

2. You should be able to view the deployed API service. Click on View.

Dell Boomi API Management - Expose RESTful Service - Screenshot 22

3. Click on REST.

Dell Boomi API Management - Expose RESTful Service - Screenshot 23

4. Click on Access Swagger Visualization Portal

Dell Boomi API Management - Expose RESTful Service - Screenshot 24

5. A dialog box appears. Select a user and click Open.

Dell Boomi API Management - Expose RESTful Service - Screenshot 25

6. A Boomi Deployed API Swagger Visualization portal opens up with the Hello API Service. Click POST.

Dell Boomi API Management - Expose RESTful Service - Screenshot 26

7. Click Try it out.

Dell Boomi API Management - Expose RESTful Service - Screenshot 27

8. Enter the below JSON request in the Hello Input text area and click Execute.

{
"firstName": "Smith",
"lastName": "Johnson"
}

Dell Boomi API Management - Expose RESTful Service - Screenshot 28

9. Validate the response received from the API service.

Dell Boomi API Management - Expose RESTful Service - Screenshot 29

Testing the Hello API Service using Postman.

1. Download postman from https://www.getpostman.com/downloads/ and install it.

2. Click on New.

Dell Boomi API Management - Expose RESTful Service - Screenshot 30

3. Click on Request.

Dell Boomi API Management - Expose RESTful Service - Screenshot 31

4. A Save Request dialog appears. Enter the details and click Save.
Request Name – Hello Service.
Click Dell Boomi API Management - Expose RESTful Service - Screenshot 32 to add a Hello Service folder to store all the Hello API service test requests.
Click Save to Hello Service.

Dell Boomi API Management - Expose RESTful Service - Screenshot 33

5. Click on the GET dropdown and select POST.

Dell Boomi API Management - Expose RESTful Service - Screenshot 34

6. Enter the URL in the Enter request URL text field. This should be the URL of the API service exposed by the Boomi API management. Click Authorization.

7. Select Type – Basic Auth. Enter Username and Password. Click Preview Request.

Dell Boomi API Management - Expose RESTful Service - Screenshot 35

8. Click Body.

Dell Boomi API Management - Expose RESTful Service - Screenshot 36

9. Choose raw

Dell Boomi API Management - Expose RESTful Service - Screenshot 37

10. Click on the Text dropdown and select JSON type.

Dell Boomi API Management - Expose RESTful Service - Screenshot 38

11. Enter the below JSON request in the text area and click Send.

{
"firstName": "Smith",
"lastName": "Johnson"
}

Dell Boomi API Management - Expose RESTful Service - Screenshot 39

12. Validate the response received from the API request.

Dell Boomi API Management - Expose RESTful Service - Screenshot 40

This completes exposing RESTful web service using Boomi API management.

Reference links:

  1. https://train.boomi.com
  2. https://help.boomi.com/bundle/integration/page/c-atm-API_Management_28fb124c-f53f-4da8-bf8e-ca89656a5f39.html
Share This