konfiguracja i podłączenie

WYSZUKIWARKA BILETÓW LOTNICZYCH
XFLY
KONFIGURACJA I PODŁACZENIE
(wersja z 04.04.2014r.)
1
Spis treści
I KONFIGURACJA............................................................................................................3
1.Dodawanie i usuwanie afliatu..................................................................................................................................... 3
2.Profl Agencji............................................................................................................................................................... 3
2.1. Dane Agencji......................................................................................................................................................................3
2.2. Profl IBE.............................................................................................................................................................................4
2.3. Zgłoszenia..........................................................................................................................................................................4
3.Konfguracja szablonu.................................................................................................................................................. 4
3.1. Kolory.................................................................................................................................................................................4
3.2. Szerokość...........................................................................................................................................................................5
4.Boxy ofertowe............................................................................................................................................................. 6
4.1. Lista boxów........................................................................................................................................................................6
4.2. Modyfkuj Boxa..................................................................................................................................................................6
4.3. Dodaj nowy box.................................................................................................................................................................9
II PODŁĄCZENIE............................................................................................................10
1. FREE-install – jako odwołanie bezpośrednio do naszych serwerów..............................................................................10
1.1. Podłączenie w ramce.......................................................................................................................................................10
1.2. Wywołanie w osobnym oknie..........................................................................................................................................10
2.GATE – wyszukiwarka osadzona na Twojej stronie internetowej..................................................................................10
2.1. Osadzenie wyszukiwarki - krok 1 i 2................................................................................................................................10
2.2. Osadzenie – krok 3 i 4......................................................................................................................................................11
3.Boxy ofertowe........................................................................................................................................................... 12
3.1. Implementacja boxów na stronie z wyszukiwarką XFly...................................................................................................12
3.2. Implementacja boxów na stronie bez wyszukiwarki Xfy................................................................................................13
2
I KONFIGURACJA
Aby skonfgurować własną wyszukiwarkę należy przejść do panelu konfguracyjnego. W tym celu logujemy się na
stronie htp://ibe01.merlinx.pl/panel/, używając loginu i hasła, które otrzymaliśmy przy zakupie usługi. Po
zalogowaniu przechodzimy do konfguracji.
1. Dodawanie i usuwanie afliatu
Przy pierwszym logowaniu należy zacząć od utworzenia nowego afliatu. W tym celu należy nacisnąć przycisk
DODAJ znajdujący się w prawym górnym rogu.
Następnie podajemy nazwę afliatu (prosimy nie używać znaków specjalnych – kropek, spacji, wykrzykników,
nawiasów itp. oraz polskich liter; dozwolone są: litery, cyfry, myślniki, znak podkreślenia), i aktywujemy EasyFlight.
Wybieramy jeden z dostępnych szablonów (narazie tylko jeden dostępny EF Template 1) i klikamy ZAPISZ.
Możemy stworzyć kilka różnych afliatów. Przy kolejnym logowaniu wystarczy wybrać afliat który chcemy
edytować / konfgurować, z listy dostępnych znajdującej się w lewym górnym rogu panelu.
Aby usunąć afliat należy wybrać jego nazwę z listy afliatów, a następnie nacisnąć przycisk USUŃ.
Po kliknięciu OTWÓRZ skonfgurowana wyszukiwarka otworzy się w nowym oknie przeglądarki internetowej,
gdzie możemy ją przetestować.
2. Profl Agencji
2.1. Dane Agencji
Podaj podstawowe dane Agencji takie jak nazwa Agencji, a także inne dane teleadresowe. Ważne jest podanie
adresu e-mail.
3
2.2. Profl IBE
W tej zakładce podajemy dane dotyczące wyszukiwarki m.in. na jakiej stronie zostanie ona umieszczona. Bardzo
ważne jest podanie adresu url dla kroku 3 (formularz rezerwacyjny). Po konfguracji należy pamiętać o zapisaniu
ustawień.
2.3.
Zgłoszenia
W tej zakładce możemy przeglądać zgłoszenia rezerwacji dokonane na naszej stronie.
3. Konfguracja szablonu
3.1.
Kolory
W zakładce KOLORY ustawiamy kolory poszczególnych elementów korzystając z palety kolorów lub wpisując
dowolny szesnastkowy kod koloru. Zmiany należy zapisać.
4
3.2.
Szerokość
W zakładce SZEROKOŚĆ używając suwaka (lub wpisując w polu) ustawiamy szerokość wyszukiwarki dopasowaną
do własnej strony internetowej. Osobne ustawienie dla wyszukiwarki głównej (step1) oraz dla pozostałych kroków
(step2-4). Uwaga przy pozostałych krokach ustawienie dotyczy części głównej wyszukiwarki, bez fltrów i
wyszukiwarki pomocniczej pionowej. Te dodatkowe elementy mają stałą szerokość. Po ustawieniu szerokości
zmiany należy zapisać.
5
4. Boxy ofertowe
Do konfguracji boxów ofertowych wykorzystujemy panel konfguracyjny IBE. Boxy są dostępne jedynie
dla szablonów typu XFly. W nowej zakładce „Boxy ofertowe” możemy zapoznać się z aktualną listą
zaprojektowanych już boxów, a także je modyfkować oraz tworzyć nowe.
4.1.
Lista boxów
Na liście boxów widzimy:
•
aktualną nazwę boxa wraz z informacją, ile ofert znaleziono na podane w boxie parametry,
•
informację, czy box był gdzieś wykorzystywany w ciągu ostatniego miesiąca (aktywny),
•
informację o numerze identyfkacyjnym boxa, który wykorzystujemy przy implementacji,
•
przycisk umożliwiający skopiowanie parametrów boxa do nowego,
•
przycisk umożliwiający usunięcie danego boxa.
4.2.
Modyfkuj Boxa
Edycja boxa umożliwia szeroki wachlarz ustawień. Ustawienia generacji boxa ograniczyliśmy do 4
elementów:
•
Nagłówek
•
Ogólny wygląd boxa
•
Wygląd ofert
•
Kryteria wyszukiwania ofert.
6
O wyglądzie nagłówka decydują następujące parametry:
•
„Typ nagłówka” – ogólna budowa tego elementu.
•
„Tytuł boxa” – zarówno nazwa boxa na liście jak i główny tekst widoczny u góry.
•
„Podtytuł boxa” – możliwość ustawienia dodatkowego tekstu.
•
„URL ikony w nagłówku” – wybór odpowiedniego typu nagłówka umożliwia wyznaczenie
niewielkiej ikony, ozdabiającej nagłówek boxa.
•
„Krój czcionki” – możliwość ustawienia stylu tekstu.
•
„Tytuł – rozmiar czcionki” – opcja zmiany rozmiaru tekstu w pikselach.
•
„Kolor tła nagłówka” – otwiera paletę barw nagłówka.
•
„Tytuł – kolor tekstu” – otwiera paletę barw tekstu tytułu.
•
„Podtytuł – kolor tekstu” – Otwiera paletę barw tekstu podtytułu.
7
Na ogólny wygląd boxa składają się poniższe parametry:
•
„Typ boxa” – decyduje o rodzaju wyświetlanego boxa. Można tu również wybrać tryb czystych
danych tekstowych, który zaawansowanym użytkownikom pozwoli na stworzenie swoich
własnych stylów prezentacji danych.
•
„Adres landing page” – należy tu podać stronę, na którą zostanie przekierowany użytkownik po
kliknięciu w ofertę na boxie. Do adresu zostaną dodane parametry zawierające lotnisko wylotowe
i docelowe klikniętej oferty.
•
„Zdjęcie główne” – tutaj wybieramy zdjęcie, które przy wytypowaniu odpowiedniego boxa
będzie w nim zawarte. Proponowane rozmiary zdjęć posiadają wymiary szerokość : wysokość w
stosunku 2 : 1 .
•
„Typ ramki” – parametr decydujący o obramowaniu boxa.
•
„Grubość ramki”.
•
„Szerokość boxa”.
•
„Kolor ramki”.
•
„Dodaj cień pod boxem”.
Część „Wygląd oferty” decyduje w jaki sposób dane zostaną przedstawione na boxie. Parametry
składające się na ten element to:
•
„Typ oferty” – wygląd lewej części oferty.
•
„Typ ceny” – wygląd prawej części oferty.
•
„Oferta – rozmiar czcionki”.
•
„Cena – rozmiar czcionki”.
•
„Tekst dodatkowy – rozmiar” – parametr decydujący o wielkości liter wszystkich elementów
dodatkowych dla wybranych trybów wyświetlania ofert oraz cen.
•
„Krój czcionki”.
•
„Oferta – wielkość liter” – sposób wyświetlania głównego elementu opisowego oferty.
•
„Cena – wielkość liter”.
•
„Typ separatora ofert” – określa styl linii oddzielającej oferty: ciągła, przerywana, kropkowana,
brak linii.
•
„Kolor tekstu – oferta”.
•
„Kolor tekstu cena”.
•
„Kolor tekstów dodatkowych”.
•
„Kolor tła ofert nieparzystych”.
•
„Kolor tła ofert parzystych”.
•
„Kolor tła ofert – podświetlenie” – parametr decydujący o kolorze tła oferty, po najechaniu na
nią myszką.
8
•
„Kolor linii separującej oferty”.
Ostatnim elementem decydującym o wyświetlanym boxie są „Kryteria wyszukiwania ofert”. Poprzez
wykorzystanie tych opcji możemy zadecydować o ofertach wyświetlanych na boxie. Dwa rodzaje
parametrów wchodzą w skład tego elementu.
•
„Typ ofert” – loty w jedną stronę i w obie strony.
•
„Ilość ofert w boxie” – maksymalna ilość ofert.
•
Istnieje również możliwość użycia check boxa „Posortuj po cenie”. Ten parametr zachowuje
kolejność wyświetlanych ofert zgodnie z ustawioną kolejnością lub sortuje oferty po cenie.
Pozostałe parametry w „Kryteriach wyszukiwania ofert” są indywidualne dla każdej oferty:
•
„Wylot z” – możemy tu wybrać dane miejsce lub zostawić puste pole – wówczas wyszukiwane
będzie najtańsze połączenie z lotniskiem docelowym, bez względu na lotnisko wylotowe.
•
„Lotnisko docelowe” – działa podobnie jak poprzedni parametr. Możemy wypełnić lub zostawić
puste, z tym że nie możemy obu parametrów zostawić niewypełnionych.
•
„Bez przesiadek” – po zaznaczeniu check boxa otrzymamy jedynie oferty bez przesiadek.
•
„Tekst własny zamiast destynacji” – jeśli nie odpowiada nam proponowany tekst opisujący ofertę
możemy go zastąpić własnym.
•
„Szukaj w terminie (od – do)” – parametr decydujący o tym, między którymi datami ma wystąpić
wyszukiwany przez nas lot. Możliwe są dwa sposoby wypełnienia tych parametrów. Pierwszy to
podanie konkretnych dat, natomiast drugi, bardziej dynamiczny, jest taki, iż wpisujemy liczbę dni
od dnia dzisiejszego. Np.: wpisując 7 i 14 chcemy aby w momencie wyświetlania boxa pokazywał
on loty występujące w dniach pomiędzy tą za tydzień a tą za dwa tygodnie.
•
„Ilość dni (od – do)” – w przypadku lotów w obie strony możemy wyznaczyć jak dużo dni ma
minąć pomiędzy wylotem w jedną i w drugą stronę.
•
„Klasa lotu”.
•
„Typ połączenia” – możliwość wyboru tanich linii, czarterów i linii regularnych (GDS).
•
„Linia lotnicza (kod ISO)” – możemy tutaj podać kod ISO konkretnej linii lotniczej, której loty nas
interesują. Opcja jest przydatna, gdy chcemy pokazać różne loty na tej samej trasie lub różne
trasy dla jednej linii lotniczej.
•
„Cena maksymalna” – decyduje o wyświetlaniu lotów w przypadku, gdy cena przekroczy podaną
wartość.
4.3.
Dodaj nowy box
Z zakładki tej korzystamy gdy chcemy utworzyć całkiem nowy box ofertowy.
9
II
PODŁĄCZENIE
1. FREE-install – jako odwołanie bezpośrednio do naszych serwerów
Przy tej opcji nie występuje opłata instalacyjna. Przy pomocy panelu konfguracyjnego przygotowujemy
wyszukiwarkę, w wyniku otrzymujemy link (opis rozdz. I, pkt. 5), który umieszczamy na własnej stronie
internetowej w ramce lub jako hiperłącze do osobnej strony.
1.1. Podłączenie w ramce
Wstawiamy ramkę z wyszukiwarką na swoją stronę. Podajemy adres wygenerowany w panelu konfguracyjnym np.
<iframe width="900" height="1000" frameborder="0" src="http://xfly.merlinx.pl/nragencji/nazwa-afilatu/"></iframe>
1.2. Wywołanie w osobnym oknie
Internauta klika link i zostaje przekierowany na stronę gdzie robi rezerwacje, (po kliknięciu linka użytkownik
zobaczy stronę z samą wyszukiwarką).
2. GATE – wyszukiwarka osadzona na Twojej stronie internetowej
Opcja GATE – podłączenie w języku programowania. Oferujemy pełne wsparcie dla PHP.
Nie ma możliwość podłączenia do strony HTML. Wymagania co do serwera: PHP 5.2 z dostępnymi funkcjami:
- json_decode() htp://www.php.net/manual/en/functon.json-decode.php
- cURL htp://www.php.net/manual/en/book.curl.php
W pierwszej kolejności wgrywamy na swój serwer dostarczoną przez nas bibliotekę ef_gate.class.php, jest to
biblioteka odpowiadająca za połączenie z naszym serwerem, (plik modyfkujemy tylko w przypadku gdy chcemy
podłączyć wyszukiwarkę używając innego języka programowania niż PHP).
Następnie umieszczamy w kodzie strony głównej (lub innej) wyszukiwarkę.
2.1.
Osadzenie wyszukiwarki - krok 1 i 2
Decydujemy gdzie i czy chcemy umieścić poszczególne części wyszukiwarki (część główną, fltry, wyszukiwarka
pomocniczą).
a) Na same samym początku pliku podłączamy bibliotekę która wgraliśmy wcześniej na serwer:
require_once('ef_gate.class.php');
UWAGA: Powyżej należy podać właściwą ścieżkę do pliku ef_gate.class.php.
W tym pliku NIE należy podawać parametrów dotyczących kodowania przy wywołaniu biblioteki
ef_gate. Zwracana zawartość powinna być w kodowaniu UTF-8 (domyślne).
Nie należy także dodawać żadnej innej zawartości do tego pliku.
b) W nagłówku dodajemy:
$ef_gate = new ef_gate('1496', 'EasyFlyTest');
10
OPIS PARAMETRÓW:
1. '1496' – jako pierwszy parametr podajemy swój numer agencji.
2. 'EasyFlyTest' – nazwa afliatu – nazwa którą podaliśmy w panelu konfguracyjnym.
c) Pobieramy fragmenty wyszukiwarki:
$ef_parts = array('headCss', 'headJs', 'mxMainForm',
'mxResultListLoaderGlobal', 'mxLandingPage');
$ef_gate->fetchParts($ef_parts);
które następnie przy pomocy funkcji $ef_gate->getPart() będą wyświetlane na stronie.
d) W sekcji HEAD dołączamy potrzebne pliki css i javascript:
echo $ef_gate->getPart('headCss', false);
echo $ef_gate->getPart('headJs', false);
e) W wybranych miejscach (gdzie chcemy) wyświetlamy część główną wyszukiwarki (wyszukiwarka,
wyniki wyszukiwania) i elementy pomocnicze (fltry, wyszukiwarka pomocnicza). Możemy pominąć
każdy z elementów.
Część główna wyszukiwarki:
// główny formularz wyszukiwania (step1):
echo $ef_gate->getPart('mxMainForm');
// ekran paska postępu widoczny
w trakcie wyszukiwania ofert:
echo $ef_gate->getPart('mxResultListLoaderGlobal');
echo $ef_gate->getPart('mxLandingPage');
// wyniki wyszukiwania (step3):
echo $ef_gate->getPart('mxResult');
Wyszukiwarka pomocnicza (pionowa):
echo $ef_gate->getPart('mxSideForm');
Filtry (pionowe):
echo $ef_gate->getPart('mxFilters');
2.2.
Osadzenie – krok 3 i 4
UWAGA: dla kroku trzeciego, gdzie znajduje się formularz rezerwacji wymagane jest użycie serwera HTTPS
(szyfrowana wersja protokołu HTTP) ze względu bezpieczeństwa (ochrony danych osobowych min. danych
karty kredytowej podawanych przy płatności). Jeśli nie dysponujemy serwerem HTTPS użytkownik zostanie
przekierowany na serwer MerlinX (opcja domyślna). Jeśli dysponujemy serwerem z prot. szyfrowanym
tworzymy dodatkowy plik i osadzamy w nim wyszukiwarkę – krok 3. Bardzo ważne jest podanie adresu url
do tej strony z formularzem w panelu konfguracyjnym ( Profl Agencji > Profl IBE > Ustawienia krok 3 >
Plik rezerwacyjny link ).
11
a) Na same samym początku pliku podłączamy bibliotekę która wgraliśmy wcześniej na serwer:
require_once('ef_gate.class.php');
b) W nagłówku dodajemy:
$ef_gate = new ef_gate('1496', 'EasyFlyTest');
c) Pobieramy fragmenty wyszukiwarki:
$ef_parts = array('headCss', 'headJs', 'mxBookingForm',
'mxResultListLoaderGlobal');
$ef_gate->fetchParts($ef_parts);
które następnie przy pomocy funkcji $ef_gate->getPart() będą wyświetlane na stronie.
d) W sekcji HEAD dołączamy potrzebne pliki css i javascript:
echo $ef_gate->getPart('headCss', false);
echo $ef_gate->getPart('headJs', false);
e) W wybranych miejscach (gdzie chcemy) wyświetlamy część główną wyszukiwarki (wyszukiwarka,
wyniki wyszukiwania) i elementy pomocnicze (fltry, wyszukiwarka pomocnicza). Możemy pominąć
każdy z elementów.
Część główna wyszukiwarki:
// formularz rezerwacji (step3):
echo $ef_gate->getPart('mxBookingForm');
// ekran paska postępu widoczny w trakcie sprawdzania dostępności oferty:
echo $ef_gate->getPart('mxResultListLoaderGlobal');
echo $ef_gate->getPart('mxResultListLoader');
Wyszukiwarka pomocnicza (pionowa):
echo $ef_gate->getPart('mxSideForm');
3.
Boxy ofertowe
Boxa możemy zaimplementować na dwa sposoby, w zależności od tego, czy na stronie jest zainstalowana
wyszukiwarka Xfy.
3.1.
Implementacja boxów na stronie z wyszukiwarką XFly
Zaczynamy od wgrania na serwer pliku ajax_box_search.php.
Następnie przechodzimy do edycji pliku w którym podłączyliśmy wyszukiwarkę Xfy.
Pierwszy sposób wykorzystuje klasę ef_gate.class.php, którą powinniśmy już posiadać. Wówczas
odpytując ją poprzez użycie funkcji fetchParts dodajemy jedynie części mxBox_[id], gdzie id to numer
identyfkacyjny boxa.
Do istniejącego osadzenia wyszukiwarki należy dodać elementy:
12
a) Po instrukcji inicjującej biblioteke ef_gate, do listy pobieranych przez wyszukiwarkę elementów należy
dodać komponent mxBox_id:
$ef_parts = array('headCss', 'headJs', 'mxMainForm',
'mxResultListLoaderGlobal', 'mxLandingPage', 'mxBox_1');
b) W miejscu osadzenia boxa należy umieścić kod PHP:
echo $ef_gate->getPart('mxBox_1');
3.2.
Implementacja boxów na stronie bez wyszukiwarki Xfy
Jeśli nie posiadamy wyszukiwarki na stronie, potrzebujemy bezpośrednio odpytać o boxy, np. tak:
<?php
$boxes = array('mxBox_1', 'mxBox_2');
$params = array( 'parts' => implode(',', $boxes) );
$c = curl_init($url = $adresWyszukiwarki . ‘/‘ . $numerAgencji . ‘ /’ .
$nazwaSzablonu . http_build_query($params));
curl_setopt($c, CURLOPT_ENCODING, 'gzip');
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$res= curl_exec($c);
curl_close($c);
if (!empty($res))
{ $result = json_decode($res, true); }
?>
<?php
echo '<div id="mxBox_1" class="mxContent">'.$result['mxBox_1']
['content'].'</div>';
?>
13