Welcome!

Industrial IoT Authors: Yeshim Deniz, Liz McMillan, Flint Brenton, Derek Weeks, Janakiram MSV

Blog Feed Post

SOAP-to-REST with Parameterized URLs and content-based routing using the Vordel API Server

The world is moving from SOAP to REST. Many applications continue to send old-style SOAP messages. Therefore, a very common usage of the Vordel API Server is to convert from legacy SOAP messages into REST API calls. This provides the best of both worlds: (1) Existing SOAP apps continue to work and don't have to be re-coded, and (2) going forward, REST APIs are used instead.

I've put together an example of this below. In this case, I'm using the common Parlay-X format which is SOAP-based, and I'm converting to the GSMA OneAPI, which is a REST API. The example I'm using is the common "amountCharging" service, which, here in Vordel, we often encounter with our telecoms customers [Side note: Here is some information about how BT, 3 UK, Telefonica, and TIM Brasil are using Vordel with their telecoms services]. 

Here's an example of a legacy SOAP message to our Parlay-X API:


<?xml version="1.0" encoding="UTF-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <par2:chargeAmount xmlns:par2="http://www.csapi.org/schema/parlayx/payment/amount_charging/v2_1/local"> <!-- Element must appear exactly once --> <par2:endUserIdentifier>www.abc.com</par2:endUserIdentifier> <!-- Element must appear exactly once --> <par2:charge> <!-- Element must appear exactly once --> <description>a</description> <!-- Zero or one occurrences --> <currency>a</currency> <!-- Zero or one occurrences --> <amount>1.0</amount> <!-- Zero or one occurrences --> <code>a</code> </par2:charge> <!-- Element must appear exactly once --> <par2:referenceCode>a</par2:referenceCode> </par2:chargeAmount> </soap:Body> </soap:Envelope>


You can see above that this is a charge for some "Game Currency", of the amount of 25 US Dollars. 

We want to convert this to a REST API call like this:

http://api.myhostname.com/1/payment/6175551234/transactions/amount

You might notice, in the example, that the "endUserIdentifier" value in the SOAP message must be mapped into part of the URL used by the REST API. This is sometimes called a "Parameterized URL", or REST API parameterization.

Let's see how this is configured at the Vordel API Server...

The first step is to register the Parlay-X WSDL. I am doing this within the API Server's Repository, which I am accessing using the Policy Studio (Under "API Server" -> "Business Services", then right-clicking on the group I want to import the service into, and selecting "Register Web Service"). 



I am choosing the "chargeAmount" operation, as shown above, by selecting it. I simply follow through the rest of the steps as default, and for the final step, I'm choosing to deploy under a group called "Default Services", which has a number of HTTP listeners, and an SSL listener, as shown below:

The API Server will automatically create the mapping from the inbound path to the policy for our Parlay-X service. 

Finally we hit "Deploy" to deploy our new SOAP service to the API Server. 


The next step is to map from the SOAP message to the REST API call. Let's see how this is done.

Here is the WSDL for the virtualized Parlay-X service at the API Gateway. I load this up into the free Vordel SOAPbox tool (or SOAPUI) in order to generate a sample SOAP request to this Parlay-X service. 


I then save this sample request as a file called "SampleSOAPMessage.xml". We will use this in order to tell the API Server how to look up the "EndUserIdentifier" value from the SOAP now.

When I registered the Parlay-X WSDL, a sample "handler" was created for me. I am going to delete this, and configure my own handler, which reads the value from the SOAP and dynamically constructs the REST API requests based on the "EndUserIdentifier" value. So first let's delete the default handler:


Next, I drag in a "Set Service Context" into my empty canvas, and I choose the WSDL for the Parlay-X service I just imported. What I am doing here is telling the API Server (and Vordel Analytics) the name of the SOAP service, so that this shows up in monitoring and Analytics. 


Remember to select "Set as start" for this filter. Otherwise it will continue to be grayed out and will not run. Here I am setting it as start:


In the next step, I am setting Schema Validation for my incoming message. Note that, if we don't want to schema-validate the message, you can skip this step. I put a green arrow from the "Set Service Context" filter into the "Schema Validation" filter. 


Next, I am using a "Retrieve from message" filter to select the value of the EndUserIdentifier field from the XML. As you can see below, I am using the XPath Wizard in Policy Studio with the sample message which I made from SOAPbox (or SOAPui if you prefer). I select the place where the EndUserIdentifer is to be found in the message, and I set that it will be placed into an attribute (variable) called "EndUserIdentifier". 



Next, I am using a "Switch" filter to switch based on the content of that "EndUserIdentifier" variable. You can see that I'm saying "If it starts with '617', use routing policy 'Route to Px Service 1", "If it starts with '212', use routing policy 'Route to Px Service 2", etc. This Switch filter is very powerful.


At this point your policy should look like this next screenshot:


So let's look at one of the routing policies which we are calling from our Switch filter. This is a routing policy which is creating a REST API request. It consists of four simple steps. 

Step one is to rewrite the URL, taking into account the EndUserIdentifier value which we read in from the SOAP message. You can see it below with the syntax ${EndUserIdentifier}


Step two is to set the verb to "GET". Because the incoming SOAP message was sent using a POST verb, but we want to use GET to connect to our REST API, I am using a "Set HTTP Verb" filter to convert the verb to "GET".


Step three is to use a "Static Router" filter to set the hostname and port of my REST API server which I want to route to:



Step four is to place a "Connection" filter after the "Static Router". I accept all the default for the "Connection" filter. Note that if I was connecting over SSL to the API, I'd have to make sure I checked the boxes for the certificates used at the endpoint, so that they are trusted.


And that's it! What we achieved here is:

1) Converting from a legacy SOAP request to a REST API call
2) Parameterization of a URL, based on a value read from a SOAP message
3) Conditional routing based on the value from a message (content-based routing).

If you'd like to see more "recipes" like this, check out the tutorials on the Vordel website.

Read the original blog entry...

More Stories By Mark O'Neill

Mark O'Neill is VP Innovation at Axway - API and Identity. Previously he was CTO and co-founder at Vordel, which was acquired by Axway. A regular speaker at industry conferences and a contributor to SOA World Magazine and Cloud Computing Journal, Mark holds a degree in mathematics and psychology from Trinity College Dublin and graduate qualifications in neural network programming from Oxford University.

@ThingsExpo Stories
SYS-CON Events announced today that T-Mobile will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on ...
The 20th International Cloud Expo has announced that its Call for Papers is open. Cloud Expo, to be held June 6-8, 2017, at the Javits Center in New York City, brings together Cloud Computing, Big Data, Internet of Things, DevOps, Containers, Microservices and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportunity. Submit your speaking proposal ...
SYS-CON Events announced today that CollabNet, a global leader in enterprise software development, release automation and DevOps solutions, will be a Bronze Sponsor of SYS-CON's 20th International Cloud Expo®, taking place from June 6-8, 2017, at the Javits Center in New York City, NY. CollabNet offers a broad range of solutions with the mission of helping modern organizations deliver quality software at speed. The company’s latest innovation, the DevOps Lifecycle Manager (DLM), supports Value S...
Cybersecurity is a critical component of software development in many industries including medical devices. However, code is not always written to be robust or secure from the unknown or the unexpected. This gap can make medical devices susceptible to cybersecurity attacks ranging from compromised personal health information to life-sustaining treatment. In his session at @ThingsExpo, Clark Fortney, Software Engineer at Battelle, will discuss how programming oversight using key methods can incre...
SYS-CON Events announced today that Hitachi, the leading provider the Internet of Things and Digital Transformation, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Hitachi Data Systems, a wholly owned subsidiary of Hitachi, Ltd., offers an integrated portfolio of services and solutions that enable digital transformation through enhanced data management, governance, mobility and analytics. We help globa...
SYS-CON Events announced today that Juniper Networks (NYSE: JNPR), an industry leader in automated, scalable and secure networks, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Juniper Networks challenges the status quo with products, solutions and services that transform the economics of networking. The company co-innovates with customers and partners to deliver automated, scalable and secure network...
NHK, Japan Broadcasting, will feature the upcoming @ThingsExpo Silicon Valley in a special 'Internet of Things' and smart technology documentary that will be filmed on the expo floor between November 3 to 5, 2015, in Santa Clara. NHK is the sole public TV network in Japan equivalent to the BBC in the UK and the largest in Asia with many award-winning science and technology programs. Japanese TV is producing a documentary about IoT and Smart technology and will be covering @ThingsExpo Silicon Val...
New competitors, disruptive technologies, and growing expectations are pushing every business to both adopt and deliver new digital services. This ‘Digital Transformation’ demands rapid delivery and continuous iteration of new competitive services via multiple channels, which in turn demands new service delivery techniques – including DevOps. In this power panel at @DevOpsSummit 20th Cloud Expo, moderated by DevOps Conference Co-Chair Andi Mann, panelists will examine how DevOps helps to meet th...
SYS-CON Events announced today that Hitachi Data Systems, a wholly owned subsidiary of Hitachi LTD., will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City. Hitachi Data Systems (HDS) will be featuring the Hitachi Content Platform (HCP) portfolio. This is the industry’s only offering that allows organizations to bring together object storage, file sync and share, cloud storage gateways, and sophisticated search an...
SYS-CON Events announced today that Hitachi, the leading provider the Internet of Things and Digital Transformation, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Hitachi Data Systems, a wholly owned subsidiary of Hitachi, Ltd., offers an integrated portfolio of services and solutions that enable digital transformation through enhanced data management, governance, mobility and analytics. We help globa...
The explosion of new web/cloud/IoT-based applications and the data they generate are transforming our world right before our eyes. In this rush to adopt these new technologies, organizations are often ignoring fundamental questions concerning who owns the data and failing to ask for permission to conduct invasive surveillance of their customers. Organizations that are not transparent about how their systems gather data telemetry without offering shared data ownership risk product rejection, regu...
SYS-CON Events announced today that SoftLayer, an IBM Company, has been named “Gold Sponsor” of SYS-CON's 18th Cloud Expo, which will take place on June 7-9, 2016, at the Javits Center in New York, New York. SoftLayer, an IBM Company, provides cloud infrastructure as a service from a growing number of data centers and network points of presence around the world. SoftLayer’s customers range from Web startups to global enterprises.
With major technology companies and startups seriously embracing IoT strategies, now is the perfect time to attend @ThingsExpo 2016 in New York. Learn what is going on, contribute to the discussions, and ensure that your enterprise is as "IoT-Ready" as it can be! Internet of @ThingsExpo, taking place June 6-8, 2017, at the Javits Center in New York City, New York, is co-located with 20th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry p...
Five years ago development was seen as a dead-end career, now it’s anything but – with an explosion in mobile and IoT initiatives increasing the demand for skilled engineers. But apart from having a ready supply of great coders, what constitutes true ‘DevOps Royalty’? It’ll be the ability to craft resilient architectures, supportability, security everywhere across the software lifecycle. In his keynote at @DevOpsSummit at 20th Cloud Expo, Jeffrey Scheaffer, GM and SVP, Continuous Delivery Busine...
Bert Loomis was a visionary. This general session will highlight how Bert Loomis and people like him inspire us to build great things with small inventions. In their general session at 19th Cloud Expo, Harold Hannon, Architect at IBM Bluemix, and Michael O'Neill, Strategic Business Development at Nvidia, discussed the accelerating pace of AI development and how IBM Cloud and NVIDIA are partnering to bring AI capabilities to "every day," on-demand. They also reviewed two "free infrastructure" pr...
SYS-CON Events announced today that Super Micro Computer, Inc., a global leader in compute, storage and networking technologies, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Supermicro (NASDAQ: SMCI), the leading innovator in high-performance, high-efficiency server technology, is a premier provider of advanced server Building Block Solutions® for Data Center, Cloud Computing, Enterprise IT, Hadoop/...
NHK, Japan Broadcasting, will feature the upcoming @ThingsExpo Silicon Valley in a special 'Internet of Things' and smart technology documentary that will be filmed on the expo floor between November 3 to 5, 2015, in Santa Clara. NHK is the sole public TV network in Japan equivalent to the BBC in the UK and the largest in Asia with many award-winning science and technology programs. Japanese TV is producing a documentary about IoT and Smart technology and will be covering @ThingsExpo Silicon Val...
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
The age of Digital Disruption is evolving into the next era – Digital Cohesion, an age in which applications securely self-assemble and deliver predictive services that continuously adapt to user behavior. Information from devices, sensors and applications around us will drive services seamlessly across mobile and fixed devices/infrastructure. This evolution is happening now in software defined services and secure networking. Four key drivers – Performance, Economics, Interoperability and Trust ...
With billions of sensors deployed worldwide, the amount of machine-generated data will soon exceed what our networks can handle. But consumers and businesses will expect seamless experiences and real-time responsiveness. What does this mean for IoT devices and the infrastructure that supports them? More of the data will need to be handled at - or closer to - the devices themselves.