xVis API består av ett antal filer, som efter anrop utför vissa moment. Det kan handla om att visa besökslistan, registrera in besökare, skriva ut etikett.
API:t anropas med http, GET och/eller POST. Det kan i vissa fall handla om rena GET anrop eller ibland en blandning av GET och POST.
GET variabeln apikey ska alltid skickas med. Det är denna som står för autentiseringen.
I xvis.config finns en tagg <APIKey>, där valfri sträng anges. Kan vara en kombination av bokstäver och siffor, men använd bara a-z/A-Z. Vid anrop, plockas apikey upp och jämförs med värdet i xvis.config, stämmer detta, så körs funktionen.
Filer som kan anropas är:
| Fil | Funktion |
|---|---|
| visitorlist.aspx | Visar besökslista för en viss dag. Kan returnera html eller xml format. Kan returnera besökare med en viss status, kommande, inne eller ute. |
| visitoractions.aspx | Behandlar en enskild besökare. Registrerar in, eller ut. Lägger till, uppdaterar eller tar bort. |
| hosts.aspx | Används för att returnera lista på värdar |
| print.aspx | Hanterar utskrifter, av etiketter eller evakueringslistor. |
| bookings.aspx | Har hand om objektsbokningen, lägger till, tar bort eller visar på olika sätt. |