(Ruby) Belgium eHealth Platform - AddressBook - Search for Professionals

See more Belgian eHealth Platform Examples

Demonstrates how to search for professionals using the AddressBook API.

For more information, see https://www.ehealth.fgov.be/ehealthplatform/nl/data/file/view/6c419e5685327eed7200d1c543c38a55d5387d30?name=AddressBook%20Consultation%20WS%20v.1%20-%20Cookbook%20v.1.11%20dd%2031082023.pdf

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.

success = true

# Provide a certificate + private key.
# Note: If your certificate + private key is located on a hardware token or smartcard, you can call a different function to load from smartcard..
cert = Chilkat::CkCert.new()
success = cert.LoadPfxFile("SSIN=12345678.acc.p12","p12_password")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

# Create the XML to be signed...

xmlToSign = Chilkat::CkXml.new()
xmlToSign.put_Tag("soapenv:Envelope")
xmlToSign.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
xmlToSign.AddAttribute("xmlns:urn","urn:be:fgov:ehealth:platformintegrationconsumertest:v1")
xmlToSign.AddAttribute("xmlns:urn1","urn:be:fgov:ehealth:platformintegrationconsumertest:types:v1")
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security",true,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd")
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"EncodingType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary")
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",true,"wsu:Id","X509-FC77E2C72083DA8E0F16711753508182856")

# ---------------------------------------------------------------------------------------------------------------
# A note about the Id's, such as X509-FC77E2C72083DA8E0F16711753508182856, TS-FC77E2C72083DA8E0F16711753508042855, etc.
# These Id's simply need to be unique within the XML document.  You don't need to generate new Id's every time.
# You can use the same Id's in each XML document that is submitted. The purpose of each Id is to
# match the XMLDsig Reference to the element in XML being referenced. 
# In other words, you could use the Id's "mickey_mouse", "donald_duck", and "goofy", and it would work perfectly OK,
# as long as no other XML elements also use the Id's "mickey_mouse", "donald_duck", or "goofy"
# ---------------------------------------------------------------------------------------------------------------

bdCert = Chilkat::CkBinData.new()
cert.ExportCertDerBd(bdCert)

xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsse:BinarySecurityToken",bdCert.getEncoded("base64"))
xmlToSign.UpdateAttrAt("soapenv:Header|wsse:Security|wsu:Timestamp",true,"wsu:Id","TS-FC77E2C72083DA8E0F16711753508042855")

dt = Chilkat::CkDateTime.new()
dt.SetFromCurrentSystemTime()
xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Created",dt.getAsTimestamp(false))
dt.AddSeconds(3600)
xmlToSign.UpdateChildContent("soapenv:Header|wsse:Security|wsu:Timestamp|wsu:Expires",dt.getAsTimestamp(false))
dt.AddSeconds(-3600)

# The body part of the SOAP request to search for professionals looks like this:
# <soapenv:Body>
#    <urn:SearchProfessionalsRequest Id="id-FC77E2C72083DA8E0F16711753508182859" IssueInstant="2016-03-23T18:49:26.968+01:00" Offset="0" MaxElements="100">
#        <urn:SSIN>74062423769</urn:SSIN>
#    </urn:SearchProfessionalsRequest>
# </soapenv:Body>

xmlToSign.UpdateAttrAt("soapenv:Body|urn:SearchProfessionalsRequest",true,"Id","id-FC77E2C72083DA8E0F16711753508182859")
xmlToSign.UpdateAttrAt("soapenv:Body|urn:SearchProfessionalsRequest",true,"IssueInstant",dt.getAsTimestamp(true))
xmlToSign.UpdateAttrAt("soapenv:Body|urn:SearchProfessionalsRequest",true,"Offset","0")
xmlToSign.UpdateAttrAt("soapenv:Body|urn:SearchProfessionalsRequest",true,"MaxElements","100")
xmlToSign.UpdateChildContent("soapenv:Body|urn:SearchProfessionalsRequest|urn:SSIN","12345678910")

gen = Chilkat::CkXmlDSigGen.new()

gen.put_SigLocation("soapenv:Envelope|soapenv:Header|wsse:Security|wsse:BinarySecurityToken")
gen.put_SigLocationMod(1)
gen.put_SigId("SIG-FC77E2C72083DA8E0F16711753508252860")
gen.put_SigNamespacePrefix("ds")
gen.put_SigNamespaceUri("http://www.w3.org/2000/09/xmldsig#")
gen.put_SignedInfoPrefixList("soapenv urn urn1")
gen.put_IncNamespacePrefix("ec")
gen.put_IncNamespaceUri("http://www.w3.org/2001/10/xml-exc-c14n#")
gen.put_SignedInfoCanonAlg("EXCL_C14N")
gen.put_SignedInfoDigestMethod("sha256")

# Set the KeyInfoId before adding references..
gen.put_KeyInfoId("KI-FC77E2C72083DA8E0F16711753508182857")

# -------- Reference 1 --------
gen.AddSameDocRef("TS-FC77E2C72083DA8E0F16711753508042855","sha256","EXCL_C14N","wsse soapenv urn urn1","")

# -------- Reference 2 --------
gen.AddSameDocRef("id-FC77E2C72083DA8E0F16711753508182859","sha256","EXCL_C14N","urn urn1","")

# -------- Reference 3 --------
gen.AddSameDocRef("X509-FC77E2C72083DA8E0F16711753508182856","sha256","EXCL_C14N","_EMPTY_","")

gen.SetX509Cert(cert,true)

gen.put_KeyInfoType("Custom")

# Create the custom KeyInfo XML..
xmlCustomKeyInfo = Chilkat::CkXml.new()
xmlCustomKeyInfo.put_Tag("wsse:SecurityTokenReference")
xmlCustomKeyInfo.AddAttribute("wsu:Id","STR-FC77E2C72083DA8E0F16711753508182858")
xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",true,"URI","#X509-FC77E2C72083DA8E0F16711753508182856")
xmlCustomKeyInfo.UpdateAttrAt("wsse:Reference",true,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3")

xmlCustomKeyInfo.put_EmitXmlDecl(false)
gen.put_CustomKeyInfoXml(xmlCustomKeyInfo.getXml())

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

gen.put_Behaviors("IndentedSignature")

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

# -----------------------------------------------
# Send the signed XML...
http = Chilkat::CkHttp.new()

success = http.SetSslClientCert(cert)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

http.SetRequestHeader("Content-Type","text/xml")
http.SetRequestHeader("SOAPAction","urn:be:fgov:ehealth:addressbook:protocol:v1:searchProfessionals")

# resp is a CkHttpResponse
resp = http.PostXml("https://services.ehealth.fgov.be/AddressBook/v1",sbXml.getAsString(),"utf-8")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.bodyStr() + "\n";
print "response status code = " + resp.get_StatusCode().to_s() + "\n";