Implementing the API Component and Advanced API Management

Document created by mike_aronson Employee on Jul 14, 2014Last modified by Adam Arrowsmith on Nov 14, 2016
Version 3Show Document
  • View in full screen mode

This article contains guidance on how to implement the API Component in the context of Advanced API Management.  
Before following these steps, it is recommended that you read the following articles and the related references links provided within them.

Getting started with the API Component and Advanced API Management

 

1. Identify/create your "Web Services Server connector" listener process(es) using the "Web Services Server Connector" per the guidance at these links:

Web service processes 

Web Services Server connector 

 

2. Create your new "API Component" per the guidance at this link: API components 

   

     2.a. In the General Settings tab, provide the Base API Path that you would like to use.  This base API path will override the default Boomi url that appears in the WSDL.  

The REST URL Path will be the web service request URL common to all of the component’s REST endpoints. This is derived by appending Base API Path to /ws/rest/.

     The SOAP URL Path will be the web service request URL common to all of the component’s SOAP endpoints. This is derived by appending Base API Path to /ws/soap/.

   2.b. Add web service server connector listener processes to your API component (the processes from step 1).  Select the "Import an Endpoint" button in the API component which will open the Add Processes dialog. You can select "Use an existing process" and then select your Web Service listener process from the drop down menu.  This will allow you to generate REST, SOAP, and/or ODdata endpoints by selecting Web Services Server listener processes to which the new endpoints will be linked.

 

Note: With this Advanced API component feature, web service server listener processes from step 1 will still be deployed independently, but they are only exposed by deployment of an API component

 

2.c. In the REST API tab, if using REST, define the REST endpoints for your new REST API.  You can either:

 

2.d. In the SOAP API tab, if using SOAP, define the SOAP endpoints for your new SOAP API.  The SOAP API's WSDL can be configured with:

  •           WSDL Namespace which will be applied as a prefix in the WSDL to object names and list nodes (without this it will default to the Boomi namespace)

 

Advanced Settings:

  •           Single Schema (all schemas are embedded in the WSDL)
  •           Multi-Schema (a schema file (XSD) is generated for each XML namespace. XSDs are linked from the WSDL other XSD).
  •           WSDL Service name that will affect the <port> and <binding> elements in the WSDL

 

 

  •           You can also either:           
    •                     generate endpoints from existing process(es) that have the Web Services Server Connector configured in the start shape (the configured action/object/operation will be imported), or
    •                     add a new SOAP endpoint manually (this will still require selecting a process)
    •                     More details are provided at this link:  http://help.boomi.com/atomsphere/GUID-B7B49378-9F04-41DF-8E1E-ADC2CDB15002.html

 

   2.e. In the Profiles tab, review JSON and XML profiles referenced in API endpoint definitions and resolve profile type conflicts per the guidance at these links:  http://help.boomi.com/atomsphere/GUID-C338CAC9-B96E-40D8-9CC0-CAB74A02BE1C.html and http://help.boomi.com/atomsphere/GUID-AA5ACF4A-D741-4724-ABB9-04409DD66CDE.html
You should NOT deploy web service components with profile type conflicts.  

 

    2.f. Save the API Component.

3. Deploy your web services server connector listener processes from step 1 to the atom.

4. Deploy your API component from step 2 to the atom.  To do this, in the Deploy tab, switch the pulldown at the top left from "Processes" to "APIs" to select and deploy the API component.

 

 

5. Enable Advanced API management at the Atom , molecule or cloud level and configure the other shared web server settings per the guidance at this link:

http://help.boomi.com/atomsphere/GUID-006CEF13-D4AB-47EF-BF68-D2040032729D.html

6. Test invocation of the web service listener process.

3 people found this helpful

Attachments

    Outcomes