{"type":"doc","content":[{"type":"paragraph","content":[{"text":"S","type":"text","marks":[{"type":"strong"}]},{"text":"imple ","type":"text"},{"text":"O","type":"text","marks":[{"type":"strong"}]},{"text":"bject ","type":"text"},{"text":"A","type":"text","marks":[{"type":"strong"}]},{"text":"ccess ","type":"text"},{"text":"P","type":"text","marks":[{"type":"strong"}]},{"text":"rotocol (SOAP) is protocol that uses an XML-based format for sending and receiving messages via web services. The SOAP XML structure can consist of: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"element that identifies the XML document as a SOAP message.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"

","type":"text","marks":[{"type":"code"}]},{"text":" element that contains header information specific to the application, like security credentials or instructions for processing the request.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element that contains call and response information.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element containing errors and status information.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To get started working with SOAP web services, let’s review a simple tutorial using a Postman public SOAP API. You can apply these concepts to your own integration projects: ","type":"text"}]},{"type":"expand","attrs":{"title":"STEP 1: Create a custom component and name it SOAP Tutorial"},"content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/2545811678"}},{"text":" named ","type":"text"},{"text":"SOAP Tutorial. ","type":"text","marks":[{"type":"strong"}]},{"text":"Open the Translator to get started! We’ll be using the following WSDL ","type":"text"}]},{"type":"paragraph","content":[{"text":"Using Postman's public SOAP APIs we can learn how to interact with a SOAP web service. When provided a country code, this SOAP web service responds with the country’s capital city. ","type":"text"}]},{"type":"paragraph","content":[{"text":"https://www.postman.com/cs-demo/public-soap-apis/request/w274p5s/captial-city-for-a-country","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.postman.com/cs-demo/public-soap-apis/request/w274p5s/captial-city-for-a-country"}}]}]}]},{"type":"expand","attrs":{"title":"STEP 2: Use a template SOAP XML structure to build SOAP request"},"content":[{"type":"paragraph","content":[{"text":"Let’s use the provided XML structure from Postman as a SOAP template to get started. Add it to the top of the Translator script. ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can see that this SOAP template contains the SOAP envelope and body. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":708,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":708,"id":"d8792794-58ef-47b0-bc4d-661d8938e85f","collection":"contentId-3169386519","type":"file","height":341}}]},{"type":"paragraph","content":[{"text":"The template will vary depending on the web service’s required SOAP structure. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"lua"},"content":[{"text":"local XmlTemplate=[==[\n\n\n \n \n \n \n \n\n]==]","type":"text"}]}]},{"type":"expand","attrs":{"title":"STEP 3: Parse the XML template and map source data to the XML. "},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"xml.parse{}","type":"text","marks":[{"type":"code"}]},{"text":" and map the your source data into the parsed XML. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Using ","type":"text"},{"text":":setInner()","type":"text","marks":[{"type":"code"}]},{"text":" we can set the Country Code value as ","type":"text"},{"text":"'CA'","type":"text","marks":[{"type":"code"}]},{"text":" for Canada. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once finished populating the XML, it must be serialized as a string before being sent in the body of the SOAP web request. This can be done using ","type":"text"},{"text":":S()","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"tostring()","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"When doing more complex processing on XML data, import the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/2968158209"}},{"text":" to extend processing capabilities and generate your SOAP XML efficiently. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":731,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1295,"id":"391724e3-2e96-415f-84e3-305ee15fb912","collection":"contentId-3169386519","type":"file","height":484}}]}]},{"type":"expand","attrs":{"title":"STEP 4: Use Custom Fields to store any configurations"},"content":[{"type":"paragraph","content":[{"text":"For SOAP web services, use ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/2500263941"}},{"text":" to store configurations such as: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The SOAP URL or endpoint. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Authentication information such as username and password.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"TLS/SSL certificates and keys if the SOAP web service requires TLS authentication. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For this tutorial, open","type":"text"},{"text":" config.json","type":"text","marks":[{"type":"strong"}]},{"text":" and add a URL configuration with the SOAP URL. ","type":"text"}]},{"type":"paragraph","content":[{"text":"http://webservices.oorsprong.org/websamples.countryinfo/CountryInfoService.wso'","type":"text","marks":[{"type":"code"}]}]},{"type":"mediaSingle","attrs":{"layout":"center","width":550,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":662,"id":"0e2a0e3c-a736-494a-a0b5-46abba744b59","collection":"contentId-3169386519","type":"file","height":240}}]},{"type":"paragraph","content":[{"text":"Store your custom fields in a ","type":"text"},{"text":"config","type":"text","marks":[{"type":"code"}]},{"text":" variable outside of ","type":"text"},{"text":"main()","type":"text","marks":[{"type":"code"}]},{"text":" to use it in your web request. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"lua"},"content":[{"text":"local config = component.fields()","type":"text"}]}]},{"type":"expand","attrs":{"title":"STEP 5: Prepare the POST request and view the response from the SOAP web service"},"content":[{"type":"paragraph","content":[{"text":"Send the request with ","type":"text"},{"text":"net.http.post{}","type":"text","marks":[{"type":"code"}]},{"text":" where: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"url","type":"text","marks":[{"type":"code"}]},{"text":" of the SOAP web service. Stored in your custom field ","type":"text"},{"text":"config","type":"text","marks":[{"type":"code"}]},{"text":" variable.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"headers","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"bfe34930-8a27-48f8-adfc-2fb9020f0346"}},{"type":"code"}]},{"text":" table providing details about the HTTP request such as ","type":"text"},{"text":"Content-Type","type":"text","marks":[{"type":"em"}]},{"text":" or ","type":"text"},{"text":"Authentication","type":"text","marks":[{"type":"em"}]},{"text":" information. This is separate from the ","type":"text"},{"text":"

","type":"text","marks":[{"type":"code"}]},{"text":" element included in the SOAP envelope of the request which stores application specific information important in processing the request. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"body","type":"text","marks":[{"type":"code"}]},{"text":" with the prepared soapXML payload. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optional: ","type":"text"},{"text":"ssl","type":"text","marks":[{"type":"code"}]},{"text":" parameter if you require TLS. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"live=true","type":"text","marks":[{"type":"code"}]},{"text":" and use the Annotations to view the returned XML response containing the corresponding capital city. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"xml.parse{}","type":"text","marks":[{"type":"code"}]},{"text":" again to parse the XML response and capture the information. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":731,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1482,"id":"b21e2ffd-38ac-4c89-af2d-dc4fc09abb5d","collection":"contentId-3169386519","type":"file","height":564}}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"In Production, use ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/2714271777"}},{"text":" and the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/2713911370"}},{"text":" to make the web request to enhance resiliency and response handling. See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://interfaceware.atlassian.net/wiki/spaces/IXB/pages/3167682569"}},{"text":" for more recommendations. ","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Here is a copy of the entire script"},"content":[{"type":"codeBlock","attrs":{"language":"lua"},"content":[{"text":"local XmlTemplate=[==[\n\n\n \n \n \n \n \n\n]==]\n\nlocal config = component.fields()\n\nfunction main(Data)\n\n -- Parse the XML SOAP template\n local X = xml.parse{data=XmlTemplate}\n \n -- Map source data to the XML\n X[\"soap:Envelope\"][\"soap:Body\"].CapitalCity.sCountryISOCode:setInner('CA')\n \n -- Serialize the XML\n local soapBody = X:S()\n\n -- Send POST request to the SOAP web service\n local response, code, headers = net.http.post{\n url=config.URL,\n headers={['Content-type']='text/xml; charset=utf-8'}, \n body=soapBody,\n live=true\n }\n -- Handle the response\n local R = xml.parse{data=response}\n local capitalCity = R[\"soap:Envelope\"][\"soap:Body\"][\"m:CapitalCityResponse\"][\"m:CapitalCityResult\"]:nodeText()\n \n trace(capitalCity)\n \nend\n","type":"text"}]}]},{"type":"paragraph"},{"type":"paragraph"}],"version":1}

Browser not supported