ATLAS API v4

Online API Tester

Try online API tester:

• Tester / text mode only - fast.
• Tester / JSON syntax highlighting - slower.
• Tester / with JSON node folding - very slow.

Interface

General communication layer

Service works as a REST API via HTTP protocol.
Endpoint URL: https://api-v4.services.atlastours.pl/

Input parameters

Parameters can be passed via GET or POST as regular form parameters.
It is recommended to use the POST method.

• action: (string) function name. List of functions below.
• searchParams: (json object) structure described below.
• params: (json object) additional function parameters.
• backCompatibility: (string).
  Ensures compatibility with the older version of the API.
  Supported values: "v2.0".

The parameters searchParams and params are required depending on the type of function being called.

Response

API returns data as JSON format and data format depends called API function.

SearchParams structure

• offersIds (array of string)
  list of product identifiers / idProductCruiseCabin (you can pass only one identifier).
• ships (array of string)
  list of ship identifiers.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• shipowners (array of string)
  list of shipowner identifiers.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• regions (array of string)
  list of region identifiers. Regions are stored in a tree structure in the database. Requesting a region by the specified identifier automatically results in searching for descendant regions of the given one.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• length (array of integer)
  range of stay length / number of nights / days.

          [
            "0": no less than
            "1": no more than
          ]
          

• portFrom (array of string)
  List of port identifiers where the cruise begins.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• departureFromCountryName (array of string)
  List of country names where the cruise begins. Values from: `port`.`countryName`.
• portTo (array of string)
  List of port identifiers where the cruise ends.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• ports (array of string) / NOT IMPLEMENTED !!!
  List of ports that must be included in the cruise itinerary.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• price (array of integer)
  Lowest price range.

          [
            "0": no less than
            "1": no more than
          ]
          

• cabins (array of one string)
  Provided as an array but only one cabin code. Queries with several types of cabins are not supported.
• departureDateFrom (date as string 'YYYY-MM-DD')
  Start date of the cruise after the specified day.
• departureDateTo (date as string 'YYYY-MM-DD')
  Start date of the cruise before the specified day.
• returnDateFrom (date as string 'YYYY-MM-DD')
  End date of the cruise after the specified day.
• returnDateTo (date as string 'YYYY-MM-DD')
  End date of the cruise before the specified day.
• departureFrom (array of string)
  departureFrom code list.
• attributes (array of one string)
  list of attributes identifiers.
  List of available identifiers and their values you can obtain by calling the function getPossibleParams().
• routes (string)
  List of product id. `product`.`idProduct`.
• productTags (array of string)
  List of productTags `productTag`.`tagName`.
• productAttrs (array of string)
  List of product attributes `productAttr`.`code`.
• currency (string)
  currency code - default is 'EUR' and currently others are not supported.
• sort (array of two strings)
  

          [
            "0": sort direction "a" | "d"
            "1": sort by "price" | "departureDate" | "returnDate"
          ]
          

• resultsPerPage (integer)
  number of results returned per page (max 100).
• resultsPageNumber (integer)
  Page number of returned results.
  First page is 1.

Functions

getPosibleParams()

getOffersList()