Page History: Web API
Compare Page Revisions
Page Revision: 22.04.2015. 02:41:PM
Korištenje eVisitor Web API funkcionalnosti
Sučelje je izvedeno kao REST service (root URI: http://www.evisitor.hr/eVisitorRhetos_API/Rest/Htz). Kroz eVisitor Web API sučelje moguće je izvršiti sve operacije koje su dostupne kroz web sučelje same eVisitor aplikacije, pri čemu vrijede ista sigurnosna i poslovna pravila. Primjeri korištenja biti će prikazani u C# programskom jeziku koristeći RestSharp REST klijent.
Dozvoljene vrijednosti šifrarnika korištenih u pozivima metoda dostupne su
ovdje.
Prijava (login)
Da bi pristup API-ju bio dozvoljen potrebno se prijaviti (login) u sustav koristeći Authentication service API (URI: http://www.evisitor.hr/eVisitorRhetos_API/Resources/AspNetFormsAuth/Authentication/), koji implementira slijedeće metode:
Login
- Interface: (string UserName, string Password, bool PersistCookie) -> bool
- Primjer request data: {"UserName":"myusername","Password":"mypassword","PersistCookie":false}
- Odgovor je true pri uspješnom loginu, inače false. Pri uspješnom loginu odgvor servera sadrži i standardni authentication cookie koji se mora slati prilikom svakog poziva API REST servisa.
Logout
- Nema nikakvih parametara, potrebno je proslijediti standardni authentication cookie. Odgovor je prazan.
Primjer prijave na sustav
Primjer se nalazi u prilogu
Htz.eVisitor.WebApi.Test.zip, u datoteci Authentication.cs
Dostupne metode
Prijava turista
- Resource: ImportTuristi
- Interface: (string xml, bool prijavi)
- Odgovor je prazan u slučaju uspješne prijave, inače sadrži validacijsku grešku zbog koje prijava nije uspjela.
- Primjer xml datoteke nalazi se u Htz.eVisitor.WebApi.Test.zip (TestData/PrijavaTurista.xml)
- Opis sadržaja xml datoteke:
- Objekt - šifra objekta u koji se turist prijavljuje
- BoravakOd - datum od kojeg turist boravi u objektu (format: YYYYMMDD, primjer 20150413)
- VrijemeBoravakOd - vrijeme od kojeg turist boravi u objektu (format: hh:mm, primjer 09:42)
- PredvidjeniBoravakDo- datum do kojeg turist predviđa boraviti u objektu (format: YYYYMMDD, primjer 20150413)
- VrijemePredvidjeniBoravakDo- vrijeme do kojeg turist predviđa boraviti u objektu (format: hh:mm, primjer 09:42)
- VrstaIsprave - šifra vrste isprave kojom turist potvrđuje identitet
- BrojIsprave - broj isprave kojom turist potvrđuje identitet
- TuristIme - ime turista
- TuristSrednjeIme - srednje ime turista (opcionalno)
- TuristPrezime - prezime turista
- Spol - ženski/muški
- DrzavaRodjenja - troslovna šifra države (ISO oznaka) rođenja (npr. HRV za Hrvatsku ili DEU za Njemačku)
- GradRodjenja - naziv grada rođenja, ukoliko je država rođenja Hrvatska onda naziv grada rođenja mora biti iz šifrarnika gradova Republike Hrvatske koji je dio eVisitor sustava
- DatumRodjenja - datum rođenja turista (format: YYYYMMDD, primjer 19760413)
- Drzavljanstvo - troslovna šifra države (ISO oznaka) čije državljanstvo ima turist (npr. HRV za Hrvatsku ili DEU za Njemačku)
- VrstaVize - šifra vrste vize (obavezno ukoliko je turist državljan države za koje Republika Hrvatska zahtjeva vizu)
- BrojVize - broj vize (obavezno ukoliko je turist državljan države za koje Republika Hrvatska zahtjeva vizu)
- DatumVazenjaVize - datum važenja vize (obavezno ukoliko je turist državljan države za koje Republika Hrvatska zahtjeva vizu)
- DrzavaPrebivalista - troslovna šifra države (ISO oznaka) prebivališta (npr. HRV za Hrvatsku ili DEU za Njemačku)
- GradPrebivalista - naziv grada prebivališta, ukoliko je država prebivališta Hrvatska onda naziv grada rođenja mora biti iz šifrarnika gradova Republike
- PrebivalisteAdresa - ulica i broj prebivališta
- GranicniPrijelaz - šifra graničnog prijelaza (obvaezno ukoliko je turist iz države koja nije članica EU)
- DatumPrijelaza - datum ulaska u EU (obvaezno ukoliko je turist iz države koja nije članica EU)
- KategorijaPlacanjaBoravisnePristojbe - šifra kategorije plaćanaja boravišne pristojbe
- EmailTurista - e-mail turista, opcionalano (podatak se validira, stoga mora biti validna email adresa)
- TelefonTurista - kontakt telefon turista, opcionalno (validan format: +385916655333)
- OrganizacijaDolaska - šifra organizacije dolaska
- VrstaPruzeneUsluge - šifra vrste pružene usluge
Odjava turista
- Resource: ImportOdjavaTurista
- Interface: (string xml)
- Odgovor je prazan u slučaju uspješne odjave, inače sadrži validacijsku grešku zbog koje odjava nije uspjela.
- Primjer xml datoteke nalazi se u Htz.eVisitor.WebApi.Test.zip (TestData/OdjavaTurista.xml)
- Opis sadržaja xml datoteke:
- Objekt - šifra objekta u kojem je turist prijavljen
- VrstaIsprave - šifra vrste isprave kojom turist potvrđuje identitet
- BrojISprave - broj isprave kojom turist potvrđuje identitet
- PredvidjeniBoravakDo- datum odjave turista (format: YYYYMMDD, primjer 20150413)
- VrijemePredvidjeniBoravakDo- vrijeme odjave turista (format: hh:mm, primjer 09:42)