Getting Started

SOAP-Based Sabre APIs Developer Start-up Kit

The SOAP-Based Sabre APIs Developer Start-up Kit contains documentation that helps application developers get started with Sabre APIs. The kit contains the documentation listed below.

  • SOAP-Based Sabre APIs Quick Start Guide. This guide introduces the Sabre Dev Studio, critical success factors, and how to contact technical support.
  • Guide to Accessing and Consuming SOAP-Based Sabre APIs. This guide is the definitive resource for all things Sabre API-related. It includes overviews on sessioning, common error responses, the different, available Sabre APIs environments, etc.
  • SOAP-Based Sabre APIs Authentication The authentication page provides quick steps for how to connect, refresh and close a connection. See the Connection Management guide for advanced connection strategies.
  • SOAP-Based Sabre APIs Connection Management. This document outlines the advanced connection strategies that all Sabre APIs subscribers must adhere to.
  • SOAP-Based Sabre APIs Versioning Strategy. This document outlines how to specify run-time versions for TPF Connector-based Sabre APIs.
  • SOAP-Based Sabre APIs Common Errors. The status codes and errors page provides a list of error types, sample response, and an overview of the common Sabre APIs error responses and how they should be handled.
  • FAQs - Answers about using Web services, for example, avoiding namespace collisions, generating proxy code with C++, and working with the Sabre system.
  • Installation Tips for Microsoft .NET Framework 1.1 - Components, patches, and installation order.
  • Sample Java test client - This runs all session and session-based, Sabre APIs Orchestration-based, and TPF Connector-based Sabre APIs.
  • SOAP-Based Sabre APIs soapUI Test Client. A project file for the open source soapUI tool ( soapui.org) demonstrating common Sabre APIs work flows.

Note: Please check the SOAP-Based Sabre API Release Notes page for the latest Sabre APIs Orchestration-based, TPF Connector-based, and Universal Services Gateway-based release notes.

SOAP-Based Sabre APIs Quick Start Guide
Guide to Accessing and Consuming SOAP-Based Sabre APIs
SOAP-Based Sabre APIs Connection Management
SOAP-Based Sabre APIs Common Infrastructure Error Messages
SOAP-Based Sabre APIs soapUI Test Client
SOAP-Based Sabre APIs FAQs
SOAP-Based Sabre APIs Microsoft .NET Framework Installation Tips
Sabre APIs SOAP Envelope Field Size Overview
TPF Connector-Based Java Rundemo Sample Client

Sample Java rundemo test client

The sample Java-based rundemo client demonstrates how to connect to and consume TPF Connector, and Orchestrated Sabre APIs without WSDL. The rundemo client is a fully functional demo application, that makes use of the SOAP with Attachment classes available from Sun Microsystems.

A brief operational description of the client follows:

  • The client reads the SOAP envelope and XML payload of the requested service from external data files and creates a SOAP with Attachments object from their contents. (The payload is a MIME attachment.) This object contained the input parameters sent to the service provider.
  • The client loads support for the HTTPS protocol. All communication with the Web service URL is sent through this encryption process.
  • The client opens a URL connection to the service provider and sends the SOAP with Attachment request message.
  • The client receives the response message from the service provider in the form of a SOAP with Attachment. The client writes the SOAP envelope and payload attachment to two separate files which you can review later.
  • The client closes the URL connection and the program is terminated

To successfully utilize the rundemo client, valid Sabre APIs security credentials are required. The Readme document in the .ZIP archive contains additional information. To download the .ZIP archive, please click on the "Use - Download" button in the upper right hand corner of this asset, and follow the prompts.

 

Sabre APIs Sample Rundemo Client

Sample Java test client

The Java test client provides a sample code base that can be used to assist in building your application. It is a multi-module Java application that uses Maven for dependency and plugin management to consume SOAP Web Services.

The following set of Sabre APIs are consumed by the client application:

  • Session management
    • SessionCreateRQ
    • SessionCloseRQ
  • Low-level services
    • OTA_AirAvailLLSRQ (2.3.0 version)
  • PNR services
    • TravelItineraryReadRQ (3.5.0 version)
  • Orchestrated Services
    • PassengerDetailsRQ (3.0.0 version)
    • EnhancedAirBookRQ (3.0.0 version)

The client code consumes the web services with WSDLs. It creates SOAP messages without attachments, so the payload is inside the SOAP body. The responses also create SOAP messages that include the payloads inside the SOAP bodies.

To run the client, you need your Sabre API security credentials: username, password, organization, and domain. The documentation/sample_client_documentation.html in the ZIP file includes more information. To download the ZIP file, click on the Download link below.

Minimum requirements

Sample project was compiled and tested with Java 7 (update 60) and Apache Maven 3.2.2

Sabre APIs Sample Java Test Client

Sample .NET client

The C# sample clients demonstrate how to open and close Sabre APIs connections explicitly and how to consume one of the travel-based Sabre APIs. The ZIP file for the sample clients includes the C# source code and a batch file that runs the sample.

This sample client project requests the OTA_AirAvailLLSRQ Service. In doing so, it must consume three Sabre APIs. First it establishes a Sabre APIs connection by requesting the SessionCreateRQ Service, then it requests the OTA_AirAvailLLSRQ Service, and finally it requests the SessionCloseRQ Service to close the connection.

This sample client uses C# for the programming language because the proxy generated by Microsoft Visual Studio .NET's wsdl.exe program is in C#.

The dotnetclientdemo.bat file runs the sample client by generating proxy code, compiling, and running each of the following three services:

  • SessionCreateRQ – SessionCreateRQClient.cs
  • OTA_AirAvailLLSRQ – OTA_AirAvailLLSRQClient.cs
  • SessionCloseRQ – SessionCloseRQClient.cs

The readme in the ZIP file has more information. To download the ZIP file, click on the Download link below.

Minimum Requirements
  • Sabre API security credentials as follows to create a connection: Username, password, organization, and domain.
  • Microsoft .NET Framework 1.1 Service Pack 1
  • Obtain and install the patch KB892202 from http://www.support.microsoft.com/kb/892202/ . You must request the patch from Microsoft Corporation.
  • Microsoft Visual Studio .NET 2003 v1.1
  • Obtain and install the patch VS7.1-KB823639-X86-Enu.exe for Visual Studio
SampleDotnetClient.sabre.zip - Sample .NET-based client for Sabre APIs

Service version removal

An important best practice to follow when planning your development is to make sure you are using the most recent version of an API. It is equally important that you periodically plan migration to an updated version of an API or to a replacement API. This guarantees that you have access to enhanced features and functionality that may have been introduced since your initial development. Sabre APIs currently support up to 5 versions of an API. Generally (and whenever possible) these five supported API versions are backwards-compatible.

Detailed versioning policies and information can be found on our API Versioning page.

Weekly system maintenance (NORM OAA)

A Sabre host application known as NORM OAA is run system wide every Sunday morning at 00:15 U.S. Central Time. NORM OAA takes about 5 minutes to run and clears every AAA in Sabre including those used by Sabre APIs customers. All active Sabre users are required to log out and log in again. Binary security tokens used by Sabre APIs are invalidated when NORM OAA runs.

NORM OAA begins at 00:15 CT with a 5-minute warning period during which any Sabre entry returns a notice that system housekeeping is about to run. If action is not taken the USG_INVALID_SECURITY_TOKEN error will result the next time a Sabre APIs service call is executed.

This development pattern describes NORM OAA in detail and suggests remediation strategies for Sabre APIs customers using session pooling to manage connections.

Sabre Weekly System Maintenance - NORM OAA

Docs Navigation