6.3 KiB
Softra Rent API - Transkrypcja: Wst?p i zasady
?r?d?o: "Oferta 37 Softra_Rent_API - zaaczni k Specyfikacja_Rent_RESTAPI_1_15.pdf"
Specyfikacja serwisu wymiany danych SOFTRA_RENT_API
Wersja 1.15
Data utworzenia: 2023-03-20 Data ostatniej modyfikacji: 2025-12-10
Spis treści Przedmiot opracowania ............................................................................................................. 4 Technologia ................................................................................................................................ 4 Architektura ................................................................................................................................ 4 Bezpieczeństwo .......................................................................................................................... 4 Opis metod ................................................................................................................................. 5
- Generowanie tokena JWT .............................................................................................. 5
- Pobranie listy oddziałów ................................................................................................ 6
- Pobranie listy dostępnych klas pojazdów ...................................................................... 7
- Pobranie listy dostępnych marek i modeli w danej klasie i oddziale ............................. 7
- Pobranie cen ................................................................................................................... 8
- Utworzenie klienta ....................................................................................................... 11
- Pobranie danych klienta ............................................................................................... 14
- Aktualizacja danych klienta .......................................................................................... 16
- Utworzenie rezerwacji.................................................................................................. 16
- Dodanie klienta do istniejącej rezerwacji................................................................... 20
- Potwierdzenie rezerwacji ........................................................................................... 20
- Anulowanie rezerwacji ............................................................................................... 21
- Pobieranie listy faktur dla rezerwacji ......................................................................... 21
- Pobieranie listy faktur związanych z klientem ........................................................... 22
- Pobieranie dokumentu faktury .................................................................................. 22
- Sprawdzenie poświadczeń klienta ............................................................................. 23
- Tworzenie tokena do zmiany hasła konta klienta ...................................................... 23
- Zmiana hasła konta klienta......................................................................................... 24
- Podsumowanie opłat przed złożeniem rezerwacji..................................................... 25
- Pobieranie listy wynajmów i rezerwacji klienta ......................................................... 27
- Pobieranie definicji oświadczeń/zgód marketingowych ............................................ 28
- Sprawdzenie czy istnieje konto dla podanego loginu ................................................ 28
- Dodawanie wpłat i kaucji do rezerwacji ..................................................................... 29
- Pobieranie listy opłat dodatkowych dla podanej rezerwacji / wynajmu ................... 30
- Pobieranie listy wpłat dla podanej rezerwacji / wynajmu ......................................... 30
- Dodawanie płatnika .................................................................................................... 31
- Wysłanie tokenu potwierdzający email dla podanego loginu klienta ....................... 32
- Potwierdzenie adresu email klienta ........................................................................... 33
- Pobieranie wszystkich symboli klas ............................................................................ 33
- Pobieranie wszystkich modeli pojazdów.................................................................... 34
- Pobieranie listy opłat zadeklarowanych w systemie ................................................. 34
- Przykład uzgodnień wdrożeniowych .......................................................................... 35
Przedmiot opracowania Specyfikacja określa API do systemu Flota Rent o nazwie „Softra_Rent_API”. Interface udostępniać będzie szereg funkcji służących do realizacji współpracy stron internetowych wypożyczalni samochodów z bazą danych systemu zarządzania wypożyczalnią „Flota Rent” produkcji firmy Softra Systemy Informatyczne.
Uwaga : Niemniejsze opracowanie stanowi utwór w rozumieniu prawa autorskiego. Prawa autorskie do niniejszego opracowania przysługują Wojciechowi Lewandowskiemu Softra Systemy Informatyczne. Opracowanie może być wykorzystywane tylko w celu uzgodnienia oferty składanej przez Softra oraz jej realizacji. Wykorzystywanie niniejszego opracowania w całości lub części bez zgody autora nie jest dozwolone. Zakres i sposób realizacji funkcji API Softra_Rent_API stanowi tajemnicę przedsiębiorstwa Softra Systemy Informatyczne.
Technologia Serwis tworzony jest w technologii REST API. Fomat wymiany danych - JSON
Architektura Architektura API uwzględnia zakłada utworzenie serwera usługi REST po stronie systemu Flota Rent oraz klienta usługi wykorzystywanego po stronie strony internetowej wypożyczalni. Oznacza to, że wywołanie metod odbywa się zawsze po stronie klienta.
Bezpieczeństwo
Zastosowano mechanizm uwierzytelniania JWT (Json Web Token). Zalecane jest ograniczenie dostępu do usługi do wskazanych przez klienta adresów IP.
Warianty odpowiedzi - statusy HTTP:
Status Opis 200 Prawidłowa odpowiedź - zwrócony obiekt odpowiadający danej metodzie
400 Błędne dane w wysyłanym żądaniu ( brak wymaganych danych, dane niekompletne )
401 Błąd autoryzacji / token nieaktualny.
403 Nieautoryzowany dostęp
500 Błąd wewnętrzny usługi
Opis metod