Technical Requirements for Interaction Between Yandex and Customer Online Systems for the Provision of Materials by the Customer

General scheme:

1. The User requests flight options between two points for the chosen date from Yandex.Flights.

2. Yandex.Flights sends a request (GET or POST) to the Customer's website in accordance with the format:

   https://api.aviapartner.ru/search? [departure = <IATA or Sirena code of the
               point of departure>] &[arrival = <IATA or Sirena code of the point of
               arrival>] &[date_forward = <date of departure “to”>]
               &[date_backward = <date of departure “from”>] &[class = <class of
               service>] &[adults = <number of adult passengers>] &[children =
               <number of children>] &[infants = <number of infants>]

   departure	Departure airport code. IATA or Sirena-Travel code.
   arrival	Arrival airport code. IATA or Sirena-Travel code.
   date_forward	Outbound flight date: YYYY-MM-DD.
   date_backward	Return flight date: YYYY-MM-DD. May be omitted.
   class	Letter symbol of service class. Acceptable values: First class — R, F, P, A. Business class — J, C, D, I, Z. Economy class — W, S, Y, B, H, K, L, M, N, Q, T, V, X, E, U, G, O.
   adults	Number of passengers over the age of 12.
   children	Number of passengers aged 2 to 12 (inclusive). May be omitted.
   infants	Number of children under the age of 2 (inclusive). May be omitted.

   departure	Departure airport code. IATA or Sirena-Travel code.
   arrival	Arrival airport code. IATA or Sirena-Travel code.
   date_forward	Outbound flight date: YYYY-MM-DD.
   date_backward	Return flight date: YYYY-MM-DD. May be omitted.
   class	Letter symbol of service class. Acceptable values: First class — R, F, P, A. Business class — J, C, D, I, Z. Economy class — W, S, Y, B, H, K, L, M, N, Q, T, V, X, E, U, G, O.
   adults	Number of passengers over the age of 12.
   children	Number of passengers aged 2 to 12 (inclusive). May be omitted.
   infants	Number of children under the age of 2 (inclusive). May be omitted.

   Request example

   https://api.aviapartner.ru/search?departure=MOW&arrival=AGP&date_forward=2017-03-19&date_backward=2017-03-26&class=E&adults=2&children=0&infants=1

3. The Customer's website returns XML with information on available offers. The response contains one or more variant, objects, each specifying trip details: a link to buy a ticket on the Customer's website and information on flights “to” (route_forward object) and “from” (route_backward object). A trip can include multiple flights.

   The route_forward and route_backward include the fareobject, which describes fares and luggage allowances.

   Field	Description	Format
   url	A URL to redirect the user to the Customer's website. The Customer must process the URL in conformance with clause 3.4 in RFC 2396 – Uniform Resource Identifiers (URI): Generic Syntax.	String
   route_forward	Information on the flight “to”.	Object
   route_backward	Information on the flight “from”. Omitted if the request did not specify the date of the return flight.	Object
   route_code	Flight number.	String
   company_code	Airline code. IATA or Sirena-Travel code.	String
   company_name	Airline name.	String
   departure_airport_code	Departure airport code. IATA or Sirena-Travel code.	String
   arrival_airport_code	Arrival airport code. IATA or Sirena-Travel code.	String
   departure_datetime	Departure date and time (local).	String
   arrival_datetime	Arrival date and time (local).	String
   route_time	Time en-route in minutes.	Numeric
   farecode	Fare code.	String
   tariff_adult	Fare for passengers over the age of 12.	Numeric
   tariff_child	Fare for passengers aged 2 to 12 (inclusive). Omitted if the request did not specify the number of children.	Numeric
   tariff_infant	Fare for children under the age of 2 (inclusive). Omitted if the request did not specify the number of infants.	Numeric
   fare	Fare and luggage information.	Object
   value	Minimum price in this service class.	Numeric
   class	Letter symbol of service class.	String
   charter	Indicates charter fare.	Boolean
   block	Indicates block fare.	Boolean
   selfconnect	Indicates separate tickets issued for flights in a trip.	Boolean
   currency	Currency.	String
   luggage	Whether the transportation of checked luggage is included in the ticket price.	Boolean
   pieces_of_luggage	Number of pieces of luggage included in the price.	Numeric
   luggage_weight	Maximum weight of luggage included in the price.	Numeric
   luggage_dimensions	Maximum dimensions of luggage included in the price.	Object
   length	Length.	Numeric
   width	Width.	Numeric
   height	Height.	Numeric
   sum	Total of length, width and height.	Numeric

   Field	Description	Format
   url	A URL to redirect the user to the Customer's website. The Customer must process the URL in conformance with clause 3.4 in RFC 2396 – Uniform Resource Identifiers (URI): Generic Syntax.	String
   route_forward	Information on the flight “to”.	Object
   route_backward	Information on the flight “from”. Omitted if the request did not specify the date of the return flight.	Object
   route_code	Flight number.	String
   company_code	Airline code. IATA or Sirena-Travel code.	String
   company_name	Airline name.	String
   departure_airport_code	Departure airport code. IATA or Sirena-Travel code.	String
   arrival_airport_code	Arrival airport code. IATA or Sirena-Travel code.	String
   departure_datetime	Departure date and time (local).	String
   arrival_datetime	Arrival date and time (local).	String
   route_time	Time en-route in minutes.	Numeric
   farecode	Fare code.	String
   tariff_adult	Fare for passengers over the age of 12.	Numeric
   tariff_child	Fare for passengers aged 2 to 12 (inclusive). Omitted if the request did not specify the number of children.	Numeric
   tariff_infant	Fare for children under the age of 2 (inclusive). Omitted if the request did not specify the number of infants.	Numeric
   fare	Fare and luggage information.	Object
   value	Minimum price in this service class.	Numeric
   class	Letter symbol of service class.	String
   charter	Indicates charter fare.	Boolean
   block	Indicates block fare.	Boolean
   selfconnect	Indicates separate tickets issued for flights in a trip.	Boolean
   currency	Currency.	String
   luggage	Whether the transportation of checked luggage is included in the ticket price.	Boolean
   pieces_of_luggage	Number of pieces of luggage included in the price.	Numeric
   luggage_weight	Maximum weight of luggage included in the price.	Numeric
   luggage_dimensions	Maximum dimensions of luggage included in the price.	Object
   length	Length.	Numeric
   width	Width.	Numeric
   height	Height.	Numeric
   sum	Total of length, width and height.	Numeric

   All the above flight information must be included in the response (as per types of passengers in the request).

   Response example

   { "variant" : [ { "url":
                     "https://api.aviapartner.ru/redirect?key=gdfkj435lkfg", {
                     "route_forward": [ { "route_code": "0123АБ",
                     "company_code": "BL", "company_name":
                     "Blah-air", "departure_airport_code": "DME",
                     "arrival_airport_code": "SVO", "departure_datetime":
                     "2011-04-01 18:12", "arrival_datetime": "2011-04-01
                     21:20", "route_time = "123", "farecode":
                     "WFLOWCS", "tariff_adult": "80.00",
                     "tariff_child": "60.00", "tariff_infant":
                     "3.45", "fare": { "value: "123.45",
                     "class: "E", "charter: "false", "block":
                     "false", "selfconnect": "false",
                     "currency": "RUB", "luggage: "true",
                     "pieces_of_luggage: 1, "luggage_weight": 20,
                     "luggage_dimensions: { "length: 90, "width: 28, "height: 40,
                     "sum: 158 } } }, {...}, {...} ] }, { "route_backward": [{...},
                     {...}, {...}] }, { } }, {...}, {...}, ... ] }

4. The Customer's offers received after 20 seconds of waiting or after the User manually interrupted the waiting are not included in the list of flight options for this user. Offers received after waiting from 20 seconds to 2 minutes are saved in the cache and displayed again if the user repeats the search, without sending another request to the Customer (until the cache expires).

5. Customers who use the Sirena-Travel system shall respond to requests using the internal codes from this system.

6. The Customer undertakes to use the HTTPS secure data transfer protocol on its website for redirecting Users from Yandex.Flights.

7. If the Customer adopts a new information delivery protocol, said Customer undertakes to notify Yandex of the change at least thirty calendar days in advance.

8. The quantity and total price of air tickets that Users purchased by clicking through from the Yandex.Flights website, which is reported by the Customer as per clause 3.3.9 of the Agreement, shall be provided in XSL/XSLX or CSV format.

9. A list of acceptable regional routes may be defined in order to limit the number of requests. To do so, send a link to a CSV file with city/airport code pairs to the email address specified in the agreement (one pair per line, using a semicolon “;” to separate the codes). Either IATA codes or Sirena-Travel codes are acceptable. Each pair allows queries in both directions.

   The file shall be UTF-8 encoded.

   Example of defining acceptable destinations

   • ATH;CMB
   • ATH;DXB
   • GBB;GOI
   • GPA;HAV
   • HER;KLX
   • KVD;LCA
   • LIS;LLK
   • LWN;MAD
   • MLE;NAP
   • СХТ;RHO
   • СХТ;СПТ

   Download a sample file

   The data are uploaded once a day.

10. Yandex appends a GET parameter marker, which is a unique string up to 200 symbols long, to the partner page URL when redirecting from Yandex.Flights.

    When booking/purchasing/canceling a ticket, the request https://avia.yandex.ru/order/pixel/[marker]/[status] shall be made to Yandex.Flights, where:

    marker	is the value of the GET parameter that Yandex.Flights transmitted when redirecting to the partner.
    status	is a value set depending on the event type. Acceptable values: Booking Paid Cancel

    marker	is the value of the GET parameter that Yandex.Flights transmitted when redirecting to the partner.
    status	is a value set depending on the event type. Acceptable values: Booking Paid Cancel

    Possible types of requests to Yandex.Flights:

    • 1. CORS request from JavaScript when the event is completed;
    • 2. HTML code to insert in a page after the user made a purchase <img src="https://avia.yandex.ru/order/pixel/[marker]/[status]">;
    • 3. Request from the partner's server after the event is completed.

    Any of these requests will inform Yandex.Flights that the user with the transmitted marker parameter booked, purchased or canceled an air ticket on the partner's website.