Wiki source code of 2. Catalogue
Last modified by Giorgi Mdivnishvili on 2024/04/11 15:51
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| |
13.1 | 5 | = API Methods Overview = |
| |
1.1 | 6 | |
| 7 | |||
| |
13.1 | 8 | This section provides a concise overview of the available API methods designed to retrieve various types of geographical and accommodation-related data. Each method supports parameters to refine search results, catering to specific data retrieval needs. |
| |
1.1 | 9 | |
| |
13.1 | 10 | == [[GetDestinationCountries>>GetDestinationCountries]] == |
| |
1.1 | 11 | |
| |
13.1 | 12 | * **Description**: Retrieves a list of destination countries. This method allows for specifying parameters to filter the returned list according to certain criteria. |
| 13 | * **Usage**: Ideal for obtaining a comprehensive list of countries to which travel services are provided, including package destinations. | ||
| |
1.1 | 14 | |
| |
13.1 | 15 | == [[GetCountries>>GetCountries]] == |
| |
1.1 | 16 | |
| |
13.1 | 17 | * **Description**: Fetches a complete list of countries. Similar to GetDestinationCountries, this method supports various parameters for filtering the country list. |
| 18 | * **Usage**: Useful for applications needing to present a global perspective, offering users a selection of countries without specific destination criteria. | ||
| |
1.1 | 19 | |
| |
13.1 | 20 | == [[GetDepartureCities>>GetDepartureCities]] == |
| |
1.1 | 21 | |
| |
13.1 | 22 | * **Description**: Obtains a list of all cities from which departures are available. This method does not require parameters and provides a straightforward list based on available data. |
| 23 | * **Usage**: Essential for setting up departure points in travel booking systems or for analytics related to departure locations. | ||
| |
1.1 | 24 | |
| |
13.1 | 25 | == [[GetArrivalDistricts>>GetArrivalDistricts]] == |
| |
6.1 | 26 | |
| |
13.1 | 27 | * **Description**: Generates a list of districts available for arrival. This method focuses on more granular geographic locations, aiding in detailed travel planning and organization. |
| 28 | * **Usage**: Best suited for applications requiring detailed destination planning down to the district level. | ||
| |
6.1 | 29 | |
| |
13.1 | 30 | == [[GetHotels>>GetHotels]] == |
| |
12.1 | 31 | |
| |
13.1 | 32 | * **Description**: Compiles a list of all hotels available in the system. This method is crucial for accommodation-focused queries and supports parameters to narrow down options. |
| 33 | * **Usage**: Central to hotel booking platforms or travel packages that include accommodation options. | ||
| |
12.1 | 34 | |
| |
13.1 | 35 | == [[GetAirportTree>>GetAirportTree]] == |
| |
12.1 | 36 | |
| |
13.1 | 37 | * **Description**: Provides a structured list of airports. This method is tailored for retrieving hierarchical airport data, useful for flight-related functionalities. |
| 38 | * **Usage**: Integral for flight booking services, airport selection interfaces, and logistic applications focusing on air travel. | ||
| |
12.1 | 39 | |
| |
13.1 | 40 | Each method is designed with flexibility and specific use cases in mind, ensuring developers can easily integrate and utilize the provided data in their applications, enhancing user experiences and backend functionalities. |
| |
12.1 | 41 | |
| 42 | |||
| |
12.2 | 43 | == Important == |
| |
12.1 | 44 | |
| 45 | {{error}} | ||
| |
12.2 | 46 | === Implementing Authorization in Subsequent Requests === |
| |
12.1 | 47 | |
| |
12.2 | 48 | For every API request after the initial authentication, it's crucial to include the authorization token in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token: |
| |
12.1 | 49 | |
| |
12.2 | 50 | * **Header Key:** Authorization |
| 51 | * **Header Value:** Bearer [Your Token Here] - Use the bearer token provided in the initial authentication response. The authorization type should be specified as Bearer Token. | ||
| |
12.1 | 52 | |
| |
12.2 | 53 | Additionally, to ensure your requests are properly formatted and recognized, include the following headers: |
| |
12.1 | 54 | |
| |
12.2 | 55 | * **Content-Type:** Specify this header as application/json to indicate the format of the request body. |
| 56 | * **Header Key:** X-nugios-timezone | ||
| 57 | * **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes. | ||
| |
12.1 | 58 | |
| |
12.2 | 59 | Incorporating these headers with their respective values is essential for the successful processing of your API requests. |
| |
12.1 | 60 | {{/error}} |