# Softra Rent API - Transkrypcja: S?owniki i uzgodnienia wdro?eniowe

> ?r?d?o: "Oferta 37 Softra_Rent_API - zaaczni k Specyfikacja_Rent_RESTAPI_1_15.pdf"

29. Pobieranie wszystkich symboli klas

Opis: Zwraca wszystkie zdefiniowane klasy pojazdów w systemie
 URL : /car/class/listAll
Typ metody : GET
Nagłówki:
  "Authorization: Bearer [token]"
Parametry JSON Object

Przyjmowane parametry: Brak

Odpowiedź  :   Obiekt typu List< String > , gdzie każdy element to symbol klasy pojazdu

30. Pobieranie wszystkich modeli pojazdów

Opis: Zwraca wszystkie zdefiniowane modele pojazdów w systemie
 URL : /car/model/listAll
Typ metody : GET
Nagłówki:
  "Authorization: Bearer [token]"
Parametry JSON Object

Paremetry GET: includeBrandDetails  true/false  (opcjonalny)

Odpowiedź  :   Obiekt typu List< CarModel > opisany w pkt 4.

31. Pobieranie listy opłat zadeklarowanych w systemie

Opis: Zwraca wszystkie zdefiniowane opłaty w sytemie które mogą użyte w cennikach
 URL : /pricelist/defList
Typ metody : GET
Nagłówki:
  "Authorization: Bearer [token]"
Parametry JSON Object

Przyjmowane parametry: Brak

Odpowiedź  :   Obiekt typu List< PriceItem > ,

Parametry PriceItem

Nazwa pola Opis pola Typ danych  Uwagi
code Symbol opłaty String
description Nazwa opłaty String

32. Przykład uzgodnień wdrożeniowych

Przed przystąpieniem do wdrożenia zleceniodawca, wykonawca strony www i Softra
powinni:
- uzgodnić scenariusz obsługi klienta na stronie internetowej
- zweryfikować użycie metod API zgodnie z uzgodnionym scenariuszem
- uzgodnić ewentualne konieczne zmiany w API

Przykładowy scenariusz obsługi klienta na stronie www

Poniżej zamieszczono przykład scenariuszy użycia dla podstawowej wersji interface
SOFTRA_RENT_API.
Scenariusze obsługi klienta mogą być modyfikowane na potrzeby użytkownika systemu.
Poniższy scenariusz należy traktować tylko jako przykład.
Zakłada się dwa scenariusze użycia :
1. Dla nowego klienta
2. Dla klienta zarejestrowanego w systemie.
Fragmenty scenariusz specyficzne dla w/w rodzajów scenariusza zaznaczono kolorem.

1. Potencjalny klient wchodzi na stronę www wypożyczalni i dokonuje podaje okres
wynajmu oraz lokalizacje odbioru i zwrotu pojazdu
2. Następuje sprawdzenie dostępnych klas pojazdów spełniających w/w kreteria i
prezentacja możliwych do wyboru modeli wraz z cenami
3. Potencjalny klient wybiera klasę pojazdu oraz wskazuje opocjonalne elementy
wyposażenia lub usługi (foteliki , pakiety znoszące odpowiedzialnosć itp)
4.  Następnie prezentowane jest podsumowanie oraz wybór czy klient chce:
 -  dokonać rezerwacji bez rejestracji (jako anonim)
 -  zalogować się na wcześniej utworzone konto
-   utworzyć konto
4. Jeżeli klient wskaże ,że jest zarejestrowanym klientem strona www wysyła do
Softra_Rent_API dane uwierzytelniające klienta i następuje weryfikacja konta kloenta.
Softra_Rent_API zwraca potwierdzenie o statusie autoryzacji.
5. Jeśli klient wskaże ,że chce utworzyć konto lub składa rezerwację bez rejestracji to
zostanie proszony jest o wypełnienie formularza rejestracji danych klienta.
6.  Klient następnie zatwierdza formularz rezerwacji i następuje złożenie rezerwacji.
7. Jeśli przy próbie rezerwacji system stwierdza brak samochodu następuje zapisanie
zamówienia i zgłoszenie informacji do operatora przez SMS o braku pojazdu.
9. Klient proszony jest o wykonanie płatności za rezerwację. Potwierdzenie wykonania
płatności wysyłane jest do Softra_Rent_API
10. Jeśli płatność została wykonana to status rezerwacji jest zmieniany na „Potwierdzone”
i wysyłany jest SMS oraz e-mail do wskazanego operatora systemu oraz e-mail
potwierdzający przyjęcie rezerwacji do klienta.

11. Jeśli płatność nie została wykonana w ciągu X  minut to następuje zmiana statusu
rezerwacji na „Anulowano”  powód  „z winy klienta”   Jeśli klient był zautoryzowany tzn. inny
niżto wysłany zostaje e-mail o anulowaniu rezerwacji.
