API Rest

Kluczowe cechy REST API TRIMAR

• Modularność – API pokrywa wszystkie istotne moduły: terminale, obszary, kasy, taryfy
• Elastyczność – możliwość działania bez autoryzacji lub z pełnym tokenem OAuth
• Wsparcie WebSocket – dla zdarzeń i poleceń w czasie rzeczywistym
• Zgodność z architekturą systemu – operacje zgodne z logiką Control Center, LAN PAY i urządzeń terenowych
• Wsparcie symulacji i testów – endpointy pomocnicze do debugowania i testowania

Poprzez interfejs API, zewnętrzni dostawcy oprogramowania mogą w łatwy sposób dokonać integracji systemów zewnętrznych np.:

• Systemy hotelowe / recepcyjne
• Stacje ładowania pojazdów elektrycznych (EV)
• Aplikacje do rezerwacji miejsc / biletów / czasu postoju
• Strony internetowe obiektów / operatorów parkingów
• Systemy miejskie / karty mieszkańca / smart city
• Aplikacje mobilne operatora lub partnerów
• Systemy flotowe i logistyka ostatniej mili
• Systemy zarządzania biurowcami
• Sklepy zintegrowane z parkingiem
• Systemy kontroli dostępu
• Systemy call center / helpdesk
• Systemy do raportowania i BI
• Systemy transportu publicznego (P+R)
• Aplikacje lojalnościowe i programy rabatowe

Api wspiera następujące obszary
Autoryzacja i dostęp

• logowanie operatorem systemu i otrzymanie tokena autoryzacji
• odczyt ról i uprawnień operatorów
  Informacje systemowe i diagnostyka
• dokumentacja wbudowana i kody zdarzeń
• testowe przykłady poprawnych i błędnych odpowiedzi
• pobieranie tłumaczeń i ustawienia języka interfejsu
  Zdarzenia i logi
• dostęp do historii zdarzeń w systemie (wjazdy, wyjazdy, płatności itp.)
• Możliwość filtrowania po czasie, urządzeniu, numerze biletu/tagu
  Struktura i obszary parkingowe
• pobieranie struktury fizycznej obiektu (obszary, terminale, urządzenia)
• monitoring i ustawianie liczników zajętości
• konfiguracja pojemności i rezerw operatora
• zmiana trybu działania obszaru (automatyczny, zawsze pełny, zawsze wolny)
• zarządzanie zachowaniem wszystkich szlabanów w obszarze
  Zarządzanie terminalami (szlabanami)
• odczyt stanu terminala (ruch ramienia, pętle indukcyjne, alarmy)
• zmiana trybu działania
• restart urządzenia lub jego uruchomienie przez sieć
• reset blokad dostępowych (An􀆟PassBack, Nest, Time/Zone)
• operacje pomocnicze: reset liczników, wydruk biletu, odczyt tablicy rejestracyjnej
  Obsługa grup użytkowników
• odczyt zajętości miejsc przypisanych do grup (standardowych i VIP)
  Zarządzanie kasami automatycznymi (APOS)
• stan urządzenia: tryb, transakcje, zawartość kaset, alarmy
• włączanie/wyłączanie urządzenia
• raport transakcji w zadanym przedziale czasu
• rozpoczęcie transakcji zgubionego biletu lub anulowanie bieżącej
• reset ograniczeń czasowych/strefowych, zdalne włączenie urządzenia
  Symulacje i testy
• generowanie biletów testowych w trybie demo
  System taryf (cenniki)
  Web Tariffs (nowoczesne, elastyczne, definiowane w JSON/YAML przez API)
• lista dostępnych taryf web
• obliczenie opłaty na podstawie czasu i taryfy
• tworzenie, zapis, usuwanie taryf
• funkcje niskopoziomowe do kompilacji i opisu taryf
  Classic Tariffs (tradycyjne, zarządzane tylko w Control Center)
• lista klasycznych taryf
• ustawienie taryfy domyślnej dla obszaru
• obliczenie opłaty według klasycznej taryfy
  Zarządzanie biletami rotacyjnymi
• odczyt informacji o bilecie (status, czas wjazdu, opłaty, lokalizacja pojazdu)
• zatwierdzenie biletu (umożliwienie wyjazdu, ustawienie ważności, tryb congress)
  Obsługa zagubionych biletów
• pobranie danych o zgubionym bilecie (na podstawie IP automatu APM)
• dodanie zgubionego i opłaconego biletu do systemu (rejestracja ręczna opłaty)
  Zarządzanie użytkownikami z prostymi kartami dostępowymi (tag users – głównie hotele)
• pobranie informacji o tagu (karta dostępu z ograniczonymi opcjami)
• zablokowanie tagu (brak możliwości wyjazdu)
• odblokowanie tagu (przywrócenie możliwości wyjazdu)
• nadanie przepustki bezpieczeństwa użytkownikowi
  Zarządzanie integracją z systemami kontroli dostępu i rezerwacjami miejsc parkingowych
• zgłoszenie zeskanowania karty/tagu przez zewnętrzny czytnik
• ustawienie listy rezerwacji tablic rejestracyjnych (whitelist)
• pobranie aktywnych rezerwacji z whitelisty w zadanym okresie
• nadpisanie wszystkich zewnętrznych rezerwacji
• aktualizacja, dodanie nowych rezerwacji (z limitem)
  Obsługa biletów rotacyjnych
• Pobiera szczegółowe informacje o bilecie rotacyjnym, w tym status, czas wjazdu, przypisaną taryfę oraz opłatę do zapłaty.
• Waliduje bilet (rotacyjny lub kongresowy), umożliwiając jego użycie przy wyjeździe z parkingu, z możliwością ustawienia
  ważności.
  Zagubione bilety
• Pobiera dane biletu zagubionego z przypisanego automatu płatniczego (APM), umożliwiając ich przetwarzanie.
• Zapisuje informacje o opłaconym bilecie zagubionym, uwzględniając opłatę, taryfę, numer biletu oraz inne szczegóły
  fiskalne.
  Karty abonamentowe / rezerwacje
• Wyszukuje użytkownika na podstawie fragmentu numeru karty, rejestracji lub imienia/nazwiska, zwracając komplet
  danych i uprawnień.
• Dodaje nowego lub aktualizuje istniejącego użytkownika sezonowego, umożliwiając pełną konfigurację kart, tablic
  rejestracyjnych, grup, reguł dostępu i parametrów ważności.
  Karty dostępowe i Tagi
• Zwraca dane o uproszczonych kartach dostępowych typu „tag”, wykorzystywanych np. przez gości hotelowych, wraz z
  przypisaniami i ograniczeniami.
• Blokuje możliwość wyjazdu użytkownika posiadającego określoną kartę, najczęściej w celu synchronizacji z systemem
  kontroli dostępu budynku.
• Odblokowuje wcześniej zablokowaną kartę, opcjonalnie na określony czas (po którym blokada zostanie automatycznie
  przywrócona).
  Integracja z systemami bezpieczeństwa
• Oznacza użytkownika jako uprawnionego do wyjazdu z parkingu po wcześniejszym potwierdzeniu obecności w systemie
  budynkowym (np. rejestracji wyjścia).
  Integracja z urządzeniami zewnętrznymi
• Symuluje zeskanowanie karty przez zewnętrzny czytnik, wywołując standardową procedurę walidacyjną jak w urządzeniu
  parkingowym.
  Rezerwacje zewnętrzne
• Ustawia listę rezerwacji tablic rejestracyjnych na białej liście, zastępując poprzednią zawartość.
• Pobiera wszystkie rezerwacje z białej listy w zadanym przedziale czasowym.
• Nadpisuje całą tabelę rezerwacji zewnętrznych nową listą dostarczoną w formacie JSON.
• Aktualizuje istniejące oraz dodaje nowe rezerwacje, usuwając nieaktywne rekordy.
• Dodaje pojedynczą rezerwację tablicy rejestracyjnej z datą rozpoczęcia i zakończenia.
• Dodaje pojedynczą rezerwację z dodatkowymi parametrami, jak lokalizacja, status An􀆟-Pass-Back oraz rezerwacja
  miejsca.
• Usuwa pojedynczą rezerwację wskazaną przez identyfikator UUID.
• Alternatywna metoda usunięcia rezerwacji wskazanej przez identyfikator UUID.
• Pobiera status An􀆟-Pass-Back rezerwacji wskazanej przez UUID (czy pojazd jest na parkingu).
• Sprawdza, czy rezerwacja została już użyta (flaga 0/1).
• Sprawdza, czy rezerwacja jest nadal ważna na podstawie podanego kodu QR
  Walidator (Validator)
• Pobiera wersję serwera i może być używany do testowania połączenia.
• Loguje użytkownika walidatora i zwraca token oraz listę dostępnych zniżek.
• Wylogowuje użytkownika z konta walidatora.
• Pobiera listę zniżek, które użytkownik walidatora może przyznać.
• Wyszukuje bilet na podstawie numeru biletu lub tablicy rejestracyjnej.
• Nakłada zniżkę na wskazany bilet (np. kwotową, procentową, czasową lub zmianę taryfy).
• Zwraca listę ostatnio zeskanowanych tablic rejestracyjnych do autouzupełniania.
• Zewnętrzne płatności mobilne (ExtAPI)
• Pobiera status biletu rotacyjnego na potrzeby płatności mobilnej, zwracając możliwe opcje opłat i token bezpieczeństwa.
• Potwierdza opłatę za bilet rotacyjny na podstawie tokena bezpieczeństwa, pozwalając na jego wykorzystanie do wyjazdu.
  Wewnętrzne operacje systemowe
• Przypisuje kod QR do numeru biletu HRI.
• Przetwarza zeskanowaną kartę UHF dostawcy w wybranym punkcie serwisowym.
• Dodaje zdarzenie z urządzenia APM, takie jak płatność, błąd lub transakcja.