(Ruby) Create Signed SOAP XML for Albanian Fiscalization Service

Important: This example requires Chilkat v9.5.0.80 or greater.

This example is created for a customer that needs to send signed billing/invoicing SOAP XML requests to http://efiskalizimi-test.tatime.gov.al:80/FiscalizationService

The example demonstrates how to create and signed the SOAP XML message that is to be sent.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# --------------------------------------------------------------------------------
# Also see Chilkat's Online WSDL Code Generator
# to generate code and SOAP Request and Response XML for each operation in a WSDL.
# --------------------------------------------------------------------------------

# We want to build and send a signed SOAP XML that looks like the following:

# 
# <?xml version="1.0" encoding="utf-8"?>
# <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
#     <SOAP-ENV:Header/>
#     <SOAP-ENV:Body>
#         <RegisterWTNRequest xmlns="https://eFiskalizimi.tatime.gov.al/FiscalizationService/schema" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#" Id="Request">
#             <Header SendDateTime="2019-09-03T14:19:01+02:00" UUID="42db3af5-0d9f-4dea-95b4-4b947ab8d8e7"/>
#             <WTN BusinUnit="bb123bb123" DateTimeCreated="2019-09-03T14:19:01+02:00" DestinAddr="Destination address" 
# 			DestinCity="Destination city" IsAfterDel="false" OperatorCode="oo123oo123" 
# 			SoftNum="ss123ss123" StartAddr="Start address" StartCity="Start city" TransDate="2019-09-03T14:19:01+02:00" 
# 			VehPlates="AA0000AA" WTNIC="5C5E58580D0A24E1F7A5E5E011929511" WTNICSignature="82D69C38206D ... F5FCA48" WTNNum="12345678901">
#                 <Issuer NUIS="I12345678I" Name="Issuer name"/>
#                 <Items>
#                     <I C="501234567890" N="Item name" Q="1.0" U="piece"/>
#                 </Items>
#             </WTN>
#             <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
#                 <SignedInfo>
#                     <CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
#                     <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
#                     <Reference URI="#Request">
#                         <Transforms>
#                             <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
#                             <Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
#                         </Transforms>
#                         <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
#                         <DigestValue>aNa0r4RW04BlsAciTUrWHGW9PADskl2op315BAQ0hTg=</DigestValue>
#                     </Reference>
#                 </SignedInfo>
#                 <SignatureValue>4/j/d4j/5xCJ2YUP+XTC6li0B94...........................KESd38NT5+puArBcNgLYIjLx/dh6Q==</SignatureValue>
#                 <KeyInfo>
#                     <X509Data>
#                         <X509Certificate>MIIE6TCCAtGgAwIBAgICEA8wDQYJKoZIhvcNA......................uoqWsSuLmA==</X509Certificate>
#                     </X509Data>
#                 </KeyInfo>
#             </Signature>
#         </RegisterWTNRequest>
#     </SOAP-ENV:Body>
# </SOAP-ENV:Envelope>

success = true
# Create the XML to be signed...
xmlToSign = Chilkat::CkXml.new()
xmlToSign.put_Tag("SOAP-ENV:Envelope")
xmlToSign.AddAttribute("xmlns:SOAP-ENV","http://schemas.xmlsoap.org/soap/envelope/")
xmlToSign.UpdateChildContent("SOAP-ENV:Header","")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest",true,"xmlns","https://eFiskalizimi.tatime.gov.al/FiscalizationService/schema")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest",true,"xmlns:ns2","http://www.w3.org/2000/09/xmldsig#")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest",true,"Id","Request")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|Header",true,"SendDateTime","2019-09-03T14:19:01+02:00")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|Header",true,"UUID","42db3af5-0d9f-4dea-95b4-4b947ab8d8e7")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"BusinUnit","bb123bb123")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"DateTimeCreated","2019-09-03T14:19:01+02:00")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"DestinAddr","Destination address")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"DestinCity","Destination city")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"IsAfterDel","false")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"OperatorCode","oo123oo123")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"SoftNum","ss123ss123")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"StartAddr","Start address")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"StartCity","Start city")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"TransDate","2019-09-03T14:19:01+02:00")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"VehPlates","AA0000AA")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"WTNIC","5C5E58580D0A24E1F7A5E5E011929511")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"WTNICSignature","82D69C38206D ... F5FCA48")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN",true,"WTNNum","12345678901")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Issuer",true,"NUIS","I12345678I")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Issuer",true,"Name","Issuer name")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Items|I",true,"C","501234567890")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Items|I",true,"N","Item name")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Items|I",true,"Q","1.0")
xmlToSign.UpdateAttrAt("SOAP-ENV:Body|RegisterWTNRequest|WTN|Items|I",true,"U","piece")

gen = Chilkat::CkXmlDSigGen.new()

gen.put_SigLocation("SOAP-ENV:Envelope|SOAP-ENV:Body|RegisterWTNRequest")
gen.put_SigLocationMod(0)
gen.put_SigNamespacePrefix("")
gen.put_SigNamespaceUri("http://www.w3.org/2000/09/xmldsig#")
gen.put_SignedInfoCanonAlg("EXCL_C14N")
gen.put_SignedInfoDigestMethod("sha256")

# -------- Reference 1 --------
gen.AddSameDocRef("Request","sha256","EXCL_C14N","","")

# Provide a certificate + private key. (PFX password is test123)
cert = Chilkat::CkCert.new()
success = cert.LoadPfxFile("qa_data/pfx/cert_test123.pfx","test123")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

gen.SetX509Cert(cert,true)

gen.put_KeyInfoType("X509Data")
gen.put_X509Type("Certificate")

# Load XML to be signed...
sbXml = Chilkat::CkStringBuilder.new()
xmlToSign.GetXmlSb(sbXml)

gen.put_Behaviors("CompactSignedXml,ForceAddEnvelopedSignatureTransform")

# Sign the XML...
success = gen.CreateXmlDSigSb(sbXml)
if (success != true)
    print gen.lastErrorText() + "\n";
    exit
end

# -----------------------------------------------
# Now to send the SOAP request....

# Note: Chilkat did not actually test this by sending the request to the server.
# The example is a best-guess for how to do it...

strXml = sbXml.getAsString()

# We'll need to add this in the HTTP header:
# SOAPAction: "https://eFiskalizimi.tatime.gov.al/FiscalizationService/RegisterWTN"

# Note: This is for the RegisterWTN request.

# You may wish to load the WSDL at https://efiskalizimi-test.tatime.gov.al/FiscalizationService-v1/FiscalizationService.wsdl into the SoapUI application to see 
# the SOAP requests..
http = Chilkat::CkHttp.new()
http.SetRequestHeader("SOAPAction","https://eFiskalizimi.tatime.gov.al/FiscalizationService/RegisterWTN")

# Some services expect the content-type in the HTTP header to be "application/xml" while
# other expect text/xml.  The default sent by Chilkat is "application/xml", but this web service
# likely expects "text/xml".  Therefore, change the content-type:
http.SetRequestHeader("Content-Type","text/xml; charset=utf-8")

# The testing endpoint for this soap service is likely:
endPoint = "https://efiskalizimi-test.tatime.gov.al/FiscalizationService-v1"

# resp is a CkHttpResponse
resp = http.PostXml(endPoint,strXml,"utf-8")
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    print "LastHeader:" + "\n";
    print http.lastHeader() + "\n";
    exit
end

responseStatusCode = resp.get_StatusCode()

# Check that the responseStatusCode equals 200...
print "Response Status Code: " + responseStatusCode.to_s() + "\n";

# Examine the exact HTTP header sent with the POST like this:
print "LastHeader:" + "\n";
print http.lastHeader() + "\n";

# Examine the XML returned by the web service:
print "XML Response:" + "\n";
xmlResp = Chilkat::CkXml.new()
xmlResp.LoadXml(resp.bodyStr())
print xmlResp.getXml() + "\n";

# Use this online tool to generate parsing code from response XML: 
# Generate Parsing Code from XML