Operacja hello pozwala w dowolnym momencie sprawdzić status działania WUI.
Zapytanie hello zwraca podstawowe informacje odnośnie działania WUI’a. Najważniejszymi ze zwracanych informacji są status działania WUI’a oraz username zalogowanego użytkownika.
WUI może znajdować się w jednym ze stanów:
- VUI_CONNECTING – WUI jest w trakcie łączenia się
- VUI_CONNECTED – WUI jest połączony, ale użytkownik nie jest zalogowany
- VUI_LOGGING_IN_OR_REGISTERING – WUI jest w trakcie logowania się lub rejestracji
- VUI_LOGGEDIN – użytkownik na WUI-u jest zalogowany. Czekanie na załadowanie danych i dostępu do sejfu
- VUI_READ_AVAILABLE – użytkownik jest zalogowany i WUI czeka na załadowanie danych do odczytu
- VUI_WRITE_AVAILABLE – użytkownik jest zalogowany i WUI czeka na status gotowości do zapisu
- VUI_BOX_READY – użytkownik jest zalogowany i dane są gotowe do odczytu i zapisu, ale jeszcze nie ma dostępu do sejfu i operacji na pieniądzach
- VUI_READY_BUT_VAULTOFFLINE – użytkownik jest zalogowany, ale nie ma jeszcze dostępu do sejfu
- VUI_READY – użytkownik jest zalogowany i WUI jest gotowy do działania
Po uruchomieniu WUI, znajduje się on w stanie VUI_CONNECTING. Kiedy osiągnie status VUI_READY, jest w pełni gotowy do działania.
Przykładowe zapytanie SOAP:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="ns1">
<soapenv:Header/>
<soapenv:Body>
<ns1:hello soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
</soapenv:Body>
</soapenv:Envelope>
Przykładowa odpowiedź SOAP:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ns1">
<SOAP-ENV:Header/>
<SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<ns1:helloResponse>
<return>
<status>VUI_READY</status>
<pid>8535</pid>
<daemon>false</daemon>
<username>billon_user</username>
<miport>9090</miport>
<adminpanelPort>9092</adminpanelPort>
<soapPort>9791</soapPort>
<sslRequired>false</sslRequired>
</return>
</ns1:helloResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Parametry zapytania:
Wiadomość nie przyjmuje parametrów
Parametry odpowiedzi:
nazwa | typ | opis |
---|---|---|
daemon | bool | czy WUI dziala jako daemon (w tle) |
soapPort | unsigned short | port SOAP |
status | string | obecny status gotowości do działnia WUI |
version | string | wersja aplikacji WUI |
isMerchant | bool | czy użytkownik ma uprawnienia merchanta (jest akceptantem) |
sslRequired | bool | czy połączenia SOAP wymagają SSL |
username | string | nazwa użytkownika zalogowanego do WUI |
adminpanelPort | unsigned short | port panelu administracyjnego WUI |
miport | unsigned short | port WUI, wykorzystywany do przyjmowania platnosci od portfeli klientow |
pid | unsigned int | numer procesu (pid) WUI’a w systemie operacyjnym |