QtravelAPI

Qtravel API

Qtravel API (QAPI) to narzędzie umożliwiające przeszukiwania oferty organizatorów turystycznych na zasadzie mechanizmów wyszukiwania kontekstowego. Za pomocą QAPI możliwe jest tworzenie i rozwijanie własnych systemów i serwisów internetowych. QAPI udostępnia funkcjonalności oraz mechanizmy dostępne w wyszukiwarce Qtravel.pl.

Jak działa Qtravel API (QAPI)?

Usługa sieciowa (Web Services) QAPI działa na na podstawie protokołu HTTP oraz języka XML. Za pomocą prostej konstrukcji URL, użytkownik uzyskuje odpowiedź z systemu Qtravel w formacie XML. Usługa QAPI podzielona jest na dwa moduły prosty i zaawansowany. Pierwszy z nich udostępnia funkcjonalność wyszukiwania kontekstowego opartą tyko na zapytaniu query. Moduł zaawansowany pozwala na korzystanie z opcji zaawansowanych systemu umożliwiających dokładniejsze sprecyzowanie zakresu przeszukiwanych danych.

QAPI Search Simple

Jest to najprostsza wersja usługi QtravelAPI, pozwala ona odpytać system Qtravel za pomocą dowolnej frazy oraz ograniczyć wyniki przy pomocy dostępnych filtrów.

Odwołując się za pomocą URL'a 
http://api.qtravel.pl/apis?qapikey=xxxxx&query=_query_&_{filtry}_
podając qapikey, query oraz opcjonalnie filtry otrzymujemy w wyniku znalezione oferty dla podanej frazy oraz filtrów.
Uwaga Należy pamiętać aby przed wysłaniem zapytania dokonać zakodowania wartości query, filtrów oraz parametrów (wersja Advanced) zgodnie z RFC1738 i RFC2396
Np. w przypadku języka PHP należy użyć funkcji http://pl.php.net/manual/pl/function.urlencode.php
Wartości oraz grupy filtrów zwracane są w API Search Response XML. Aby dokonać filtrowania aktualnie zwróconych wyników należy dołączyć do URL'a nazwę grupy poprzedzając znakiem “&” oraz podając jedną wartość z uzyskanych wyników. Przy podaniu więcej niż jednej wartości dla filtra z danej grupy system weźmie pod uwagę tylko ostatnią podaną wartość. Dodawanie kolejnych filtrów odbywa się w logice AND, co oznacza że zwrócony wynik będzie zawierał wszystkie zadane grupy filtrów.

Dostępne filtry

  • page - Numer strony wyników
  • sort - Metoda sortowania wyników, dostępne stałe wartości:
    • ct - wg. ceny i trafności (domyślnie)
    • a - wg. alfabetu
    • t - wg. trafności
    • d - wg. daty
    • c - wg. ceny
    • td - wg. trafności i daty
  • f_promo - Typ promocji
  • f_country - Państwo
  • f_city - Miasto
  • f_month - Miesiąc od
  • f_price - Cena, dostępne stałe wartości:
    • do 1000 zł - cena do 1000 zł
    • od 1000 do 2000 zł - cena od 1000 do 2000 zł
    • od 2000 do 3000 zł - cena od 2000 do 3000 zł
    • od 3000 do 4000 zł - cena od 3000 do 4000 zł
    • od 4000 do 5000 zł - cena od 4000 do 5000 zł
    • powyżej 5000 zł - cena od 5000 zł
  • f_period - Długość wyjazdu, dostępne stałe wartości:
    • do 7 dni - długość wyjazdu do 7 dni
    • 7 dni - długość wyjazdu dokładnie 7 dni
    • od 7 do 14 dni - długość wyjazdu od 7 do 14 dni
    • 14 dni - długość wyjazdu dokładnie 14 dni
    • od 15 do 20 dni - długość wyjazdu od 15 do 20 dni
    • powyżej 21 dni - długość wyjazdu od 21 dni
  • f_mainte - Wyżywienie
  • f_depart - Miejsce wyjazdu
  • f_person - Liczba osób
  • f_trans - Dojazd
  • f_tourop - Organizator
  • f_region - Region
  • f_categ - Kategoria hotel

Przykład

Poniższe odwołanie zwróci ofertę dla frazy windsurfing dla biura Wezyr 
http://api.qtravel.pl/apis?qapikey=125371768e33eb299b923ed3ca28e71c&query=windsurfing&f_tourop=Wezyr

Testuj QAPI Search Simple

Aby przetestować działanie QAPI Simple skorzystaj z testowego QAPI-KEY: 125371768e33eb299b923ed3ca28e71c
W wersji testowej filtry ograniczono do grup: państwo, kategoria hotelu, zakres cen, organizator, transport.

QAPI Search Advanced

QAPI Search Advanced jest zaawansowaną wersją usługi QtravelAPI, pozwala ona odpytać system Qtravel za pomocą dowolnej frazy query oraz dodatkowych zaawansowanych parametrów. Zwrócone wyniki można ograniczyć przy pomocy dostępnych filtrów.

Dostęp do opisu usługi QAPI Search Advanced (QAPI SA) możliwy jest po wcześniejszym zarejestrowaniu oraz otrzymaniu klucza dostępu QAPI-KEY.

Format zwracanych wyników - QAPI Search Response

QAPI Search Response to opis formatu wg którego zwracane są wyniki zapytań skierowanych do systemu Qtravel za pomocą usług QAPI Search Simple oraz QAPI Search Advanced. W XML zwracanym przez QAPI znajdują się wszystkie informacje związane z ofertą. W zwracanym XML'u zawarte są linki do:
  • • oferty na stronie organizatora
  • • do QAPI Offer - systemu zwracającego informację o ofercie w formacie XML
  • • oferty w serwisie Qtravel.pl
W zależności od potrzeb użytkownika QAPI może on skorzystać z najbardziej odpowiadającej mu formy odnośnika.
Dostęp do QAPI Search Response (QAPI SR) możliwy jest po wcześniejszym zarejestrowaniu oraz otrzymaniu klucza dostępu QAPI-KEY.

Jaki jest koszt używania QAPI?

System rozliczenia uzależniony jest od metody w jaki użytkownik zdecyduje się przekierowywać użytkownika.

W przypadku przekierowania z wyników zwracanych przez QAPI Search Response do serwisu Qtravel.pl używanie QAPI jest bezpłatne.

W przypadku gdy użytkownika korzysta z przekierowania do QAPI Offer lub do strony organizatora usługa QAPI udostępniana jest w modelu rozliczeniowym PPQ (Pay Per Query) - płatność za zapytanie. Oznacza to że użytkownik ponosi koszt każdego zapytania wysłanego do systemu QAPI Search. Ważnym jest fakt, że użytkownik QAPI ponosi tylko koszt odpytania QAPI Search, ewentualne odpytanie QAPI Offer jest bezpłatne.

Koszt używania nie jest uzależniony od zakresu przeszukiwanych danych ani liczby funkcji specjalnych dostępnych w XML zwracanym przez QAPI. Koszt udostępnienia mechanizmów QAPI określany jest indywidualnie dla każdego użytkownika. Wysokość zależna jest od planowanej częstotliwości odpytań.

Jak uzyskać dostęp do QAPI?

Aby uzyskać dostęp do QAPI należy wysłać zgłoszenia na adres qapi@qtravel.pl. W zgłoszeniu nalezy podać nazwę firmy oraz adres serwisu dla którego będzie wykorzystywana usługa QAPI. Następnie użytkownik po zaakceptowaniu "Warunków korzystania z QAPI" otrzymuje klucz dostępu „QAPI-KEY”, umożliwiający korzystanie z QAPI. Q&Q zastrzega sobie prawo odmowy przyznania klucza aktywacji bądź jego unieważnienia jeśli ubiegający się o dostęp do QAPI w ocenie Q&Q może naruszać interesy Q&Q bądź jego partnerów.

Użytkownicy wyświetlający wyniki zwracane przez usługę QAPI, zobowiązani są do umieszczenia w widocznym miejscu informacji: "Powered by QtravelAPI" linkującej do strony http://api.qtravel.pl.

Q&Q nie ponosi odpowiedzialności za informacje zawarte w opisie oferty oraz ceny przekazywane użytkownikowi za pośrednictwem QAPI.
Przekazywane za pośrednictwem QAPI informacje lub ceny nie stanowią oferty w rozumieniu przepisów kodeksu cywilnego. Właścicielem informacji przekazywanych za pomocą QAPI są poszczególni organizatorzy, których dane są udostępniane za pośrednictwem QAPI.