OTA API - Getting Started

1 Audience
2 Product Overview
3 Authentication
- 3.1 HTNG Header
- 3.2 Sample

Audience

This document is intended for distribution channels and their development teams that wish to connect to the Allora IBE properties.

The reader should be familiar with web services, XML and SOAP.

Product Overview

This API is based on the OTA XML schema using the HTNG authentication format. The technical feasibility of the integrations must be established prior to working on detailed development and testing work.

The IBE API enables web-based distribution systems - i.e. online booking channels, within the hospitality industry to send ARI information to a property on the IBE. The API will respond to each request synchronously to indicate the success/failure of the request.

Reservations will then be pushed from the IBE to the external channel. Reservations/Modifications/Cancellations are supported and will require a synchronous response from the third party for the reservation in the IBE to be processed appropriately.

Authentication

All messages must contain a SOAP envelope that contains a header and body. The header contains the authentication credentials and communication information required to access the API. The body contains the primary content of the message.

The third party will be provided with a set of credentials, username and password in order to gain access to the API. These credentials must be transmitted in the HTNG header section of the SOAP envelope along with an appropriate systemID that uniquely identifies the external channel.

HTNG Header

Element / @Attribute	Quantity	Type	Description

Element / @Attribute	Quantity	Type	Description
HTNGHeader	1		Room element
From	1		This identifies the system sending the message
systemID	0..1	String	The identifier of the system sending the message
Credential	1		The credentials required to gain access to the API
userName	1	String	The username element of the credentials
password	1	String	The password element of the credentials
To	0..1		This identifies the system the message is intended for
systemId	0..1	String	The intendifier of the system receiving the message
echoToken	1	Timestamp	Used as a message ID to uniquely identify the message

Sample

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Header>
      <HTNGHeader xmlns="http://htng.org/1.1/Header/">
         <From>
            <systemId>API Debug</systemId>
            <Credential>
               <userName>usernam</userName>
               <password>password</password>
            </Credential>
         </From>
         <To>
            <systemId>Convert5</systemId>
         </To>
         <echoToken>1716980112</echoToken>
      </HTNGHeader>
   </soap:Header>
</soap:Envelope>