Node js how to consume SOAP XML web service

Question

I wonder what is the best way to consume SOAP XML web service with node js  Thanks

User · Answer

I used the node net module to open a socket to the webservice.

/* on Login request */
socket.on('login', function(credentials /* {username} {password} */){   
    if( !_this.netConnected ){
        _this.net.connect(8081, '127.0.0.1', function() {
            logger.gps('('+socket.id + ') '+credentials.username+' connected to: 127.0.0.1:8081');
            _this.netConnected = true;
            _this.username = credentials.username;
            _this.password = credentials.password;
            _this.m_RequestId = 1;
            /* make SOAP Login request */
            soapGps('', _this, 'login', credentials.username);              
        });         
    } else {
        /* make SOAP Login request */
        _this.m_RequestId = _this.m_RequestId +1;
        soapGps('', _this, 'login', credentials.username);          
    }
});

Send soap requests

/* SOAP request func */
module.exports = function soapGps(xmlResponse, client, header, data) {
    /* send Login request */
    if(header == 'login'){
        var SOAP_Headers =  "POST /soap/gps/login HTTP/1.1\r\nHost: soap.example.com\r\nUser-Agent: SOAP-client/SecurityCenter3.0\r\n" +
                            "Content-Type: application/soap+xml; charset=\"utf-8\"";        
        var SOAP_Envelope=  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
                            "<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:SOAP-ENC=\"http://www.w3.org/2003/05/soap-encoding\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:n=\"http://www.example.com\"><env:Header><n:Request>" +
                            "Login" +
                            "</n:Request></env:Header><env:Body>" +
                            "<n:RequestLogin xmlns:n=\"http://www.example.com.com/gps/soap\">" +
                            "<n:Name>"+data+"</n:Name>" +
                            "<n:OrgID>0</n:OrgID>" +                                        
                            "<n:LoginEntityType>admin</n:LoginEntityType>" +
                            "<n:AuthType>simple</n:AuthType>" +
                            "</n:RequestLogin></env:Body></env:Envelope>";

        client.net.write(SOAP_Headers + "\r\nContent-Length:" + SOAP_Envelope.length.toString() + "\r\n\r\n");
        client.net.write(SOAP_Envelope);
        return;
    }

Parse soap response, i used module - xml2js

var parser = new xml2js.Parser({
    normalize: true,
    trim: true,
    explicitArray: false
});
//client.net.setEncoding('utf8');

client.net.on('data', function(response) {
    parser.parseString(response);
});

parser.addListener('end', function( xmlResponse ) {
    var response = xmlResponse['env:Envelope']['env:Header']['n:Response']._;
    /* handle Login response */
    if (response == 'Login'){
        /* make SOAP LoginContinue request */
        soapGps(xmlResponse, client, '');
    }
    /* handle LoginContinue response */
    if (response == 'LoginContinue') {
        if(xmlResponse['env:Envelope']['env:Body']['n:ResponseLoginContinue']['n:ErrCode'] == "ok") {           
            var nTimeMsecServer = xmlResponse['env:Envelope']['env:Body']['n:ResponseLoginContinue']['n:CurrentTime'];
            var nTimeMsecOur = new Date().getTime();
        } else {
            /* Unsuccessful login */
            io.to(client.id).emit('Error', "invalid login");
            client.net.destroy();
        }
    }
});

Hope it helps someone

User · Answer

You don t have that many options   You ll probably want to use one of    node-soap strong-soap  rewrite of node-soap  easysoap

User · Answer

Adding to Kim  J s solution  you can add preserveWhitespace true in order to avoid a Whitespace error  Like this   soap CreateClient url preserveWhitespace true function

User · Answer

I managed to use soap wsdl and Node js You need to install soap with npm install soap  Create a node server called server js that will define soap service to be consumed by a remote client  This soap service computes Body Mass Index based on weight kg  and height m    const soap   require  soap    const express   require  express    const app   express           this is remote service defined in this file  that can be accessed by clients  who will supply args    response is returned to the calling client    our service calculates bmi by dividing weight in kilograms by square of height in metres     const service       BMI Service        BMI Port          calculateBMI args              console log Date   getFullYear            const year   new Date   getFullYear            const n   args weight    args height   args height           console log n           return   bmi  n                            xml data is extracted from wsdl file created const xml   require  fs   readFileSync    bmicalculator wsdl    utf8      create an express server and pass it to a soap server const server   app listen 3030  function       const host    127 0 0 1     const port   server address   port      soap listen server    bmicalculator   service  xml     Next  create a client js file that will consume soap service defined by server js  This file will provide arguments for the soap service and call the url with SOAP s service ports and endpoints   const express   require  express    const soap   require  soap    const url    http   localhost 3030 bmicalculator wsdl   const args     weight  65 7  height  1 63    soap createClient url  function err  client      if  err  console error err     else       client calculateBMI args  function err  response          if  err  console error err         else           console log response           res send response                             Your wsdl file is an xml based protocol  for data exchange that defines how to access a remote web service  Call your wsdl file bmicalculator wsdl   lt definitions name  HelloService  targetNamespace  http   www examples com wsdl HelloService wsdl     xmlns  http   schemas xmlsoap org wsdl      xmlns soap  http   schemas xmlsoap org wsdl soap      xmlns tns  http   www examples com wsdl HelloService wsdl     xmlns xsd  http   www w3 org 2001 XMLSchema  gt      lt message name  getBMIRequest  gt       lt part name  weight  type  xsd float   gt       lt part name  height  type  xsd float   gt     lt  message gt      lt message name  getBMIResponse  gt       lt part name  bmi  type  xsd float   gt     lt  message gt      lt portType name  Hello PortType  gt       lt operation name  calculateBMI  gt         lt input message  tns getBMIRequest   gt         lt output message  tns getBMIResponse   gt       lt  operation gt     lt  portType gt      lt binding name  Hello Binding  type  tns Hello PortType  gt       lt soap binding style  rpc  transport  http   schemas xmlsoap org soap http   gt       lt operation name  calculateBMI  gt         lt soap operation soapAction  calculateBMI   gt         lt input gt           lt soap body encodingStyle  http   schemas xmlsoap org soap encoding   namespace  urn examples helloservice  use  encoded   gt         lt  input gt         lt output gt           lt soap body encodingStyle  http   schemas xmlsoap org soap encoding   namespace  urn examples helloservice  use  encoded   gt         lt  output gt       lt  operation gt     lt  binding gt      lt service name  BMI Service  gt       lt documentation gt WSDL File for HelloService lt  documentation gt       lt port binding  tns Hello Binding  name  BMI Port  gt         lt soap address location  http   localhost 3030 bmicalculator     gt       lt  port gt     lt  service gt   lt  definitions gt    Hope it helps

User · Answer

The simplest way I found to just send raw XML to a SOAP service using Node js is to use the Node js http implementation  It looks like this   var http   require  http    var http options       hostname   localhost     port  80    path    LocationOfSOAPServer      method   POST     headers         Content-Type    application x-www-form-urlencoded        Content-Length   xml length        var req   http request http options   res    gt      console log  STATUS    res statusCode       console log  HEADERS    JSON stringify res headers        res setEncoding  utf8      res on  data    chunk    gt        console log  BODY    chunk              res on  end        gt        console log  No more data in response              req on  error    e    gt      console log  problem with request    e message             write data to request body req write xml      xml would have been set somewhere to a complete xml document in the form of a string req end      You would have defined the xml variable as the raw xml in the form of a string   But if you just want to interact with a SOAP service via Node js and make regular SOAP calls  as opposed to sending raw xml  use one of the Node js libraries  I like node-soap

User · Answer

If you just need a one-time conversion  https   www apimatic io dashboard modal transform lets you do this by making a free account  no affiliation  it just worked for me   If you transform into Swagger 2 0  you can make a js lib with   wget https   repo1 maven org maven2 io swagger codegen v3 swagger-codegen-cli 3 0 20 swagger-codegen-cli-3 0 20 jar     -O swagger-codegen-cli jar   java -jar swagger-codegen-cli jar generate     -l javascript -i orig wsdl-Swagger20 json -o   fromswagger

User · Answer

I successfully used  soap  package  https   www npmjs com package soap  on more than 10 tracking WebApis  Tradetracker  Bbelboon  Affilinet  Webgains          Problems usually come from the fact that programmers does not investigate to much about what remote API needs in order to connect or authenticate    For instance PHP resends cookies from HTTP headers automatically  but when using  node  package  it have to be explicitly set  for instance by  soap-cookie  package

User · Answer

Depending on the number of endpoints you need it may be easier to do it manually   I have tried 10 libraries  soap nodejs  I finally do it manually      use node request  https   github com mikeal request  to form input xml message to send  POST  the request to the web service   use xml2j   https   github com Leonidas-from-XIV node-xml2js   to parse the reponse

User · Answer

For those who are new to SOAP and want a quick explanation and guide  I strongly recommend this awesome medium article   You can also use node-soap package  with this simple tutorial

User · Answer

You can use wsdlrdr also  EasySoap is basically rewrite of wsdlrdr with some extra methods   Be careful that easysoap doesn t have the getNamespace method which is available at wsdlrdr

User · Answer

I think that an alternative would be to    use a tool such as SoapUI  http   www soapui org  to record input and output xml messages use node request  https   github com mikeal request  to form input xml message to send  POST  the request to the web service  note that standard javascript templating mechanisms such as ejs  http   embeddedjs com   or mustache  https   github com janl mustache js  could help you here  and finally use an XML parser to deserialize response data to JavaScript objects   Yes  this is a rather dirty and low level approach but it should work without problems

User · Answer

If node-soap doesn t work for you  just use node request module and then convert the xml to json if needed    My request wasn t working with node-soap and there is no support for that module beyond the paid support  which was beyond my resources  So i did the following     downloaded SoapUI on my Linux machine  copied the WSDL xml to a local file curl http   192 168 0 28 10005 MainService WindowsService wsdl  gt  wsdl file xml In SoapUI I went to File  gt  New Soap project and uploaded my wsdl file xml  In the navigator i expanded one of the services and right clicked the request and clicked on Show Request Editor    From there I could send a request and make sure it worked and I could also use the Raw or HTML data to help me build an external request   Raw from SoapUI for my request  POST http   192 168 0 28 10005 MainService WindowsService HTTP 1 1 Accept-Encoding  gzip deflate Content-Type  text xml charset UTF-8 SOAPAction   http   Main Service AUserService GetUsers  Content-Length  303 Host  192 168 0 28 10005 Connection  Keep-Alive User-Agent  Apache-HttpClient 4 1 1  java 1 5    XML from SoapUI   lt soapenv Envelope xmlns soapenv  http   schemas xmlsoap org soap envelope   xmlns qtre  http   Main Service  gt      lt soapenv Header  gt      lt soapenv Body gt         lt qtre GetUsers gt            lt qtre sSearchText gt  lt  qtre sSearchText gt         lt  qtre GetUsers gt      lt  soapenv Body gt   lt  soapenv Envelope gt     I used the above to build the following node request   var request   require  request    let xml     lt soapenv Envelope xmlns soapenv  http   schemas xmlsoap org soap envelope   xmlns qtre  http   Main Service  gt      lt soapenv Header  gt      lt soapenv Body gt         lt qtre GetUsers gt            lt qtre sSearchText gt  lt  qtre sSearchText gt         lt  qtre GetUsers gt      lt  soapenv Body gt   lt  soapenv Envelope gt    var options       url   http   192 168 0 28 10005 MainService WindowsService wsdl     method   POST     body  xml    headers         Content-Type   text xml charset utf-8        Accept-Encoding    gzip deflate        Content-Length  xml length       SOAPAction   http   Main Service AUserService GetUsers          let callback    error  response  body    gt      if   error  amp  amp  response statusCode    200        console log  Raw result   body       var xml2js   require  xml2js        var parser   new xml2js Parser  explicitArray  false  trim  true        parser parseString body   err  result    gt          console log  JSON result   result                  console log  E   response statusCode  response statusMessage        request options  callback

User · Answer

You may also look at the easysoap npm - https   www npmjs org package easysoap -or- https   www npmjs com package express-soap2json

[xml] Node.js: how to consume SOAP XML web service

Examples related to xml

Examples related to node.js

Examples related to soap