API Definition

Overview

Communication Protocol

The communication protocol between properties and GalapagosGDS API consists of HTTPS (HTTP Secure) transactions with embedded JSON documents. Note the following:

Only HTTPS posts to GalapagosGDS’s secure server are supported. Using HTTP will not work (GalapagosGDS API servers are not configured to accept posts over unsecured HTTP).
Communication is synchronous -- on the same socket, GalapagosGDS API reads the request and issues a positive or negative response, depending on whether GalapagosGDS API is able to process the request or not.
Content-Type of the HTTP Request Header should be: “text/JSON”.
Only connecting via our URLs is supported. GalapagosGDS does not support connection directly via IP Address, as this address is subject to change without notice. If the GalapagosGDS partner generally prefers IP Addresses for communication performance reasons, it may consider implementing an address caching strategy to reduce DNS lookups for the URLs. Additionally, if partner whitelists outbound connections, it must do so using a URL pattern rather than an IP range, as GalapagosGDS cannot guarantee a specific IP range / subnet.

Search availability Request (SA RQ)

SA RQ Schema Complete Definition

Legend: O = Optional

Level	Element / @Attribute	Data Type	Number of occur.	Description
0	from	date	1	Start Date of the search
0	to	date	1	End Date of the search
0	cabins	array	1	An array that hold cabin adults and childs
1	@adults	number	any	Number of adults for the availability search
1	@children	array	any	An array that hold cabin child ages
0	cruise_length	string	1	A string that has {min} - {max} number days of the tour
0	category	number	1	Cruise class to be searched
0	boat_type	number	1	Boat type to be searched
0	boat_id	number	1	Specific boat to be searched
0	agency_id	number	1	Agency that is being searched

Search availability Response (SA RS)

The Search availability response message is straightforward: it is returned synchronously to update the property’s system with the status of the SA request. The status can either be Success or Error. If successful, it can contain a warning.

SA RS Schema Complete Definition

Legend: O = Optional

Level	Element / @Attribute	Data Type	Number of occur.	Description
0	boats	array	1	Array of Boats
1	@id	number	any	Id of the boat
1	@name	string	any	Name of the boat
1	@description	string	any	Description of the boat
1	@photo	array	any	Array of photos
2	@type	number	any	Type of the photo url
2	@photo_url	string	any	Url of the photo
2	@photo_name	string	any	Name of the photo
1	@child_age	number	any	Max age of the person to be considered as child
1	@min_age	number	any	Min age of the person to be considered as a passenger
1	@category	number	any	Cruise class of the boat
1	@available-tours	array	any	Array of available tours for the boat
2	@id	number	any	Id of the tour available
2	@name	string	any	Name of the tour available
2	@days	string	any	Number of days of the tour available
2	@departure_date	date	any	Date of the tour to depart
2	@description	number	any	Description of the tour available
2	@departure_destination	string	any	Destination from which the tour departs
2	@arrival_destination	number	any	Destination on which the tour will end
2	@available-cabins	array	any	Array of available cabins of the boat
3	@id	number	any	Id of the cabin
3	@name	string	any	Name of the cabin
3	@description	string	any	Description of the cabin
3	@children_price	number	any	Price per children of the cabin
3	@adult_price	number	any	Price per adult of the cabin
3	@single_supplement	number	any	Single supplement of the cabin
3	@agency_default_discount	number	any	Agency default discount of the cabin
3	@available	number	any	Available number of the cabins
3	@hold	number	any	Booked number of the cabins