Seitenhistorie

...

Authorization: Bearer <HOTEL_TOKEN>

Content-Type: application/soap+xml; charset=utf-8 +
SOAPAction: OTA_HotelResNotifRQ

The Authorization (Bearer) token is generated for your service when installed and sent to you using a secure method. It can be either in the HTTP header or in the SOAP Header

 Authorization is not mandatory in the HTTP header. However it is preferred. It should be like this in the HTTP header

Authorization: Bearer C6MmpEFjRRSy288V1hGETMBImNJhFzv5

Or it can be in the SOAP header, like this

...

C6MmpEFjRRSy288V1-DEMO-hGETMBImNJhFzv5
CorrelationID: RES#047616#UPDATE#000025#1594029290242#546D

SOAPAction

Messages sent to Protel IO (ESB)

...

...

Format of SOAP Environment

In order to process your incoming requests, all of your messages must contain headers inside the SOAP environment

SOAPAction: <MethodName>

CorrelationID: <ID_for_the_message_exchange>

We use the HTTP Headers as a location for these parameters, to keep it easy and have the important information at hand before even reading the xml document.

...

...

...

There is only 1 mandatory SOAPHeader for SYNC communication. Protel prefers to not use sync message patterns, due to scalability concerns. 

`p:Target`

Example: Mandatory HTTP headers parameters for Inbound messages

HTTP Header: Accept: application/soap+xml, text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
HTTP Header: Content-Type: application/soap+xml
HTTP Header: SOAPAction: OTA_HotelAvailNotifRS
HTTP Header: Authorization: Bearer C6MmpEFjRRSy288V1hGETMBImNJhFzv5

...

<?xml version='1.0' encoding='utf-8'?>
<env<soapenv:Envelope xmlns:soapenvenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv	<env:Header>
        		<p:Action xmlns:p="http://protel.io/soap">$1 OTA>OTA_HotelAvailNotifRS<HotelResNotifRQ</p:Action>
		<p:CorrelationID xmlns:p="http://protel.io/soap">RES#047616#UPDATE#000025#1594029290242#546D</p:CorrelationID>
		<p:Source xmlns:p="http://protel.io/soap" Module="backline" ModuleVersion="2020-07-02T10:28:55 (PROD)" Product="protelAir" ProductVersion="2027.1.56845-RELEASE" Service="io.protel.air"/>
		<htnga:CorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">RES#047616#UPDATE#000025#1594029290242#546D</htnga:CorrelationID>
		<p:TokenTarget xmlns:p="http://protel.io/soap">$2 C6MmpEFjRRSy288V1hGETMBImNJhFzv5<p:Token>
    </soapenv:Header>
        ...
</soapenv:Envelope>

1. Official message name sent as webservice (SOAPAction)
2. Token generated for this service installation in for particular hotel/customer by protel

Authentication for Outbound messages

For messages outgoing to the vendor we send the official message name in the HTTP Header as  e.g. SOAPAction:<OTA_HotelResNotifRQ>

SOAPAction:<MethodName>

protel IO always sends out the CorrelationID, which identifies (uniqueID) the message pair (RQ/RS)

CorrelationID: <ID_for_the_message_pair>

>io.protel.air</p:Target>
	</env:Header>
	<env:Body>
		--OTA/IO/HTNG Message--
	</env:Body>
</env:Envelope>

Format of the Acknowledgment (ASYNC communication)

To communicate with an ASYNC pattern, the receiver of the message needs to send an ACK with the HTTP status code 200 and the following payload back to the sender before the receiver starts the processing of the message. 

The Content-Type needs to be added in the HTTP Header with the value "application/soap+xml". 

Please note that depending on the message group used, the ACK has some differences between the standard OTA/HTNG and the protel extension IO message types:

Example of SOAPHeader sent from protel I/O

Additionally protel IO sends out a SOAPHeader with Outbound messages

<?xml version='1.0' encoding='UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
	<env:Header>
		<htnga:CorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">%1$s</htnga:CorrelationID>
		<htnga:RelatesToCorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">%1$s</htnga:RelatesToCorrelationID>
	</env:Header>
	<env:Body>
		<ns:HTNG_AcknowledgeReceipt xmlns:ns="http://htng.org/2014B"/>
	</env:Body>
</env:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
	<env:Header>
		<htnga:CorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">%1$s</htnga:CorrelationID>
		<htnga:RelatesToCorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">%1$s</htnga:RelatesToCorrelationID>
	</env:Header>
	<env:Body>
		<io:IOAcknowledgeRS CorrelationID="%1$s" xmlns:io="http://protel.io/soap"><soapenv:Header>
    <wsa:MessageID>$1</wsa:MessageID>
    <htng:CorrelationID>$2</htng:CorrelationID>
    <wsa:Action>$3</wsa:Action>
    <wsa:To>$4</wsa:To>
    <wsa:ReplyTo>
        <wsa:Address>http://www.w3.org/2005/08/addressing/role/anonymous</wsa:Address>
    </wsa:ReplyTo>
    <wsse:Security mustUnderstand="1">
        <wsse:UsernameToken>
            <wsse:Username>$5</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">$6</wsse:Password>
        </wsse:UsernameToken>
    </wsse:Security>
    <htng:ReplyTo>
        <wsa	<io:Address>$7<Success>true</wsaio:Address>Success>
        </htngio:ReplyTo>IOAcknowledgeRS>
	</soapenv:Header>

$1 - ID generated for this particular message

$2 - ID generated for this particular message exchange (at least for RQ, ACK and RS)

$3 - Official message name sent as webservice Action

$4 - URL of receiving system’s endpoint

$5 - Username if authentication is done using this schema

$6 - Password if authentication is done using this schema

$7 - URL of receiving system’s endpoint

Testing Connectivity with a Dummy API

To test the SOAP Function, systems can call
https://api-dev.protel.net/services/SoapDummyService.SoapDummyServiceHttpsSoap11Endpoint,
which returns a static OTA_HTNG Body.

Websocket Support

To connect the websocket, the client has to authenticate itself using the correct hotel token.
Once authenticated the client will receive incoming RQ messages for the hotel the token was issued for.
The websocket client also receives incoming RS messages on the same websocket connection, it has used to sent a RQ message before.

env:Body>
</env:Envelope>

Image Added

protel I/O Connection Endpoints

Connecting

...

to TEST

Connecting

...

to PROD

Connecting to prod:prod

Format of the Acknowledgment (ASYNC communication)

To communicate with an ASYNC pattern, the receiver of the message needs to send an ACK with the HTTP status code 200 and the following payload back to the sender before the receiver starts the processing of the message. 

...

...

NAT Gateway IP Addresses

Circular Message Flow