Authentication


Accessing the Sandbox Environment

Use the following URL in your flow to access the sandbox for the NDC API and endpoints. Refer to the table below to the service and associated URL.

https://oss.services.atpco.net/ndcexchange

Sandbox Service Endpoints

ServiceSandbox Endpoint/URL
Air Shopping/ndc/17.2/v1/AirShopping
Service List/ndc/17.2/v1/ServiceList
Seat Availability/ndc/17.2/v1/SeatAvailability
Offer Price/ndc/17.2/v1/OfferPrice
Order Create/ndc/17.2/v1/OrderCreate
Order Retrieve/ndc/17.2/v1/OrderRetrieve
Order Reshop/ndc/17.2/v1/OrderReshop
Order Cancel/ndc/17.2/v1/OrderCancel
OrderChange/ndc/17.2/v1/OrderChange

API Key

To access the NDC API, each seller should provide the “apikey” in the HTTP header.

OrderCreateRQ and OrderChangeRQ requires two additional headers (see below).

The API key is a unique authorization key issued by ATPCO. Currently, API keys for sellers are manually generated by ATPCO.

POST https://c/ndcexchange/ndc/17.2/v1/AirShopping

Request Headers

apikey: XXXXXXXXXXXXXXXXXXXXXX

Content-Type: application/xml

Accept: */*

Host: oss.services.atpco.net

Accept-Encoding: gzip, deflate, br

Connection: keep-alive

In addition to the above, when conducting an OrderCreateRQ or OrderChangeRQ, you must submit an additional two mandatory HTTP headers in OrderCreate or OrderChange Request.

First Mandatory HTTP Header:

  • Name: TX-Proxy-Key
  • Value: XXXXXXXXXXXXXXXXXXXXXXXX (value send to each seller)

Second Mandatory HTTP Header:

  • Name: tx-http-timeout:
  • Value: 120

TraceID

To enable us to follow up your transactions associated to your requests/responses in the sandbox, we need you to turn on trace and provide the transaction ID.

Ensure you have set orc-debug = “true” to pass in the header.

orc-debug_true.png

When retrieving the responses for tech support, you need to capture the value of “HTTP header orc-transaction-id” value and insert in the Transaction ID/Trace field in the ticket.

orc-transaction-id.png

SOAP Message

Below is the XML-based protocol that is used for the exchange of NDC information. Each request needs to be wrapped in a SOAP envelope. It is the root element of the message and defines the XML document as a SOAP message.

Message RQ (SOAP)Sample ValueRemarks
HeaderEmpty, used for schema compatibility
Body
NDCMSG_Envelope
NDCMSG_Header
SchemaTypeNDCStatic, same for all messages
SchemaVersionYY.2017.2Static, same for all messages
Sender
SellerIDatpco.ndc.key.SELLER_SPECIFIC_IDSeller’s key
Recipient
Address.CompanyCode for Offer OWNER for 1-1 services
NDCMSG_Body
NDCMSG_Payload
<![CDATA[
<IATA_NDC_Message>AirShoppingRQ, OfferPriceRQ, SeatAvailabilityRQ, ServiceListRQ, OrderCreateRQ, OrderRetrieveRQ, OrderReshopRQ, OrderCancelRQMVP supported messages
]]>

Message Structure Example

This is the general structure of any messages accepted by NDC.

IATA NDC Message

The below values represent the general structure for IATA 17.2 supported messages.

IATA NDC Message RQSample ValueRemarks
Version17.2Mandatory
EchoToken12345Optional, echo back in response
TimeStamp2011-04-28T12:48:00ZOptional, time stamp when response was built
TransactionIdentifierdaadf3d1d87245a187c64fdbba9b235Optional, echo back in response
SequenceNumbr1Optional, echo back in response
PointOfSaleOptional
LocationPoint of sale location information
CountryCodeUSRequired for Non-IATA/ARC Accredited
DocumentMandatory in schema
NameATPCO NDCFixed value
ReferenceVersionIATA NDC 17.2Fixed value
PartyMandatory in schema
SenderMandatory
TravelAgencySenderSeller is a travel agency
AgencyID99111222Mandatory
IATA_Number88888888Required for IATA/ARC Accredited
AgentUser/PseudoCityIADOptional
ParticipantsMessage Participant(s), Optional
ParticipantParticipant detail
EnabledSystem
SystemID4cdcdba1Data type for unique NDC-Enabled system ID
ParametersParameters that influence overall message results
LanguagesRequested and/or Actual Primary and/or Alternate message content language(s)
LanguageCodeen-caThe primary language preference for the message
CurrCodesCurrency information
FilledInCurrency
CurrCodeUSDCurrency code

Message Structure Example

This is the general structure for supported IATA 17.2 messages.