How to Build a RESTful web service

Document created by mike_aronson Employee on May 12, 2014Last modified by mike_aronson Employee on Jul 6, 2017
Version 2Show Document
  • View in full screen mode
You need to set up a process to receive a RESTful request from a third party application
Create a new process and select the “Web Service Server” Connector on the start shape and Action = Listen.
Then create a new operation component
and configuration the operation to use the Simple URL path as described at the link below

 

http://help.boomi.com/atomsphere/GUID-BB0B00D8-5FD7-4668-9DC7-37B26E34977E.html

 

The Simple URL path represents an endpoint for requests and posted data that is not in a SOAP or structured format. 
RestFul requests are not in a structured format, but are defined with these aspects below (also described at http://en.wikipedia.org/wiki/Representational_state_transfer)
• base URI, such as http://example.com/resources/
• an Internet media type for the data. This is usually XML or JSON
• standard HTTP methods (e.g., GET, PUT, POST, or DELETE)

 

The Simple URL path will be appended with the operation type in lowercase plus the object name, so you will want to at a minimum select the appropriate Operation Type from the pull down menu and enter an Object name.
or Input type, you can select either Single Data, XML or JSON and then coordinate with your third party application end user to define a format in which the data should be supplied.

 

The process will consume the request and then you can add shapes to your process to manipulate the data as needed for further processing based on your requirements.
For example, you can create a Profile that matches the format of the incoming data to use it in a Map which you can then map it to the appropriate endpoint. 

When your process is completed, deploy it to the atom that will be listening for the request.

 

To determine the base URI described above, go to Atom Management -> Shared Web Server Settings as described at this link:
Shared Web Serverpanel 

 

If needed for security, configure Basic Authentication or X.509 SSL Certificates can be selected in the SSL Certificate field as described at the link above. This is the SSL certificate used by the atom server. This controls whether or not SSL will be used.

 

The certificate that is selected will also be searchable in the Build tab where you can open it and export the public key and send it to the user of the third party app.
Or you can select a new atom and a create a new certificate (either by creating it in Boomi or imported it into Boomi per the guidance at this link: http://help.boomi.com/atomsphere/GUID-55FC6D6A-745B-4ED6-9F90-8D59B5565711.html
5 people found this helpful

Attachments

    Outcomes