Rozbudowaliśmy i uporządkowaliśmy bramki API Clients i Reservations , zrównując możliwości API z możliwościami w panelu IdoSell Booking a także dodaliśmy nowe bramki

15 maja 2019

W ostatnich miesiącach skupiliśmy nasze prace na mocnej rozbudowie naszego API. Za cel postawiliśmy sobie dwie bramki - Clients i Reservations. Teraz każda z tych bramek została odwzorowana i zrównana z możliwościami systemu administracyjnego IdoSell Booking. Wśród nowości znajdziesz szereg możliwości jak np. możliwość modyfikacji waluty rezerwacji przez API, rabatu czy obsługę wszystkich przycisków informujących gościa lub serwis zewnętrzny na temat rezerwacji i wiele innych. Ponadto dodaliśmy dwie nowe bramki, dzięki którym możesz zarządzać płatnościami dla rezerwacji oraz obsługiwać dokumenty (faktury VAT) dla rezerwacji.

API panelu administracyjnego IdoSell Booking pozwala na wykonywanie operacji przez aplikacje zewnętrzne, w taki sam sposób jaki wykonuje operacje w systemie IdoSell Booking użytkownik. Dzięki API panelu możliwe jest łączenie aplikacji gotowych i pisanych indywidualnie oraz automatyzacja wymiany informacji. Informacja dedykowana jest tzw. developerom, czyli osobom samodzielnie piszącym programy.

Bramka API Reservations

Zrównaliśmy ale też uporządkowaliśmy bramkę API Reservations odpowiedzialną za zarządzanie rezerwacjami. Od teraz wszelkie dane i opcje związane z rezerwacjami są możliwe do dodawania czy edycji także poprzez API. Poniżej znajdziesz listę nowości w API dotyczących bramki API Reservations.

Metoda zmieniająca status rezerwacji (editStatus)

Dodaliśmy możliwość edycji statusów rezerwacji. Za pomocą tej metody (editStatus) możesz zmienić status rezerwacji zgodnie z ich obiegiem w rezerwacji. Oznacza to, że rezerwacja posiadająca w danej chwili dany status, poprzez API zmienić może się tylko na jeden z tych które po nim mogą wystąpić. Przykładowo status Oczekuje na wpłatę można zmienić na Przyjęta, Niepoprawny numer karty lub Anulowana. Analogicznie sprawa wygląda w przypadku pozostałych statusów.

Ponadto metoda zabezpiecza przed nadaniem rezerwacji nieprawidłowego statusu, np. ustawienie statusu trwająca dla rezerwacji, która jeszcze się nie zaczęła.

Metoda zmieniająca walutę w rezerwacji (changeCurrency)

Dzięki tej metodzie możesz zmienić walutę w danej rezerwacji. W przypadku gdy w systemie IdoSell Booking ustawiony masz tryb automatycznego ustalania kursu, waluta w rezerwacji również będzie przeliczona zgodnie z kursem waluty. na karcie rezerwacji taka zmiana jest dostępna z przycisku.

Metoda pozwalająca na ustawienie rabatu dla rezerwacji (setDiscount)

Na karcie rezerwacji jest możliwość wpisania rabatu do rezerwacji. Teraz wysokość rabatu możesz dodać i zmieniać poprzez API. W tym celu wystarczy skorzystać z metody setDiscount.

Metoda zwracająca źródła rezerwacji (getSources)

Za pomocą tej metody możesz pobrać informacje na temat źródeł rezerwacji w panelu IdoSell Booking. Dodatkowo taką informację dodaliśmy również w odpowiedzi dla metody Reservation/get, pobierającej informacje o żądanej rezerwacji. Informacja zwrotna dotyczy wszystkich rezerwacji, czyli: złożonej przez obsługę w panelu oraz rezerwacji agregowanych, złożonej przez Widget IdoSell Booking, serwisy partnerskie, serwisów zewnętrznych.

Metoda wysyłająca wiadomości do klienta na temat rezerwacji (notifyClient)

Dzięki tej metodzie możesz przesyłać do klienta, który złożył rezerwację wiadomości transakcyjne na temat jego rezerwacji. Wzorem przycisków z karty rezerwacji możesz wysłać wiadomości pt. Wysyłka e-maila z bieżącym stanem rezerwacji i Wysyłka prośby o wpłatę.

Metoda informująca serwis zewnętrzny o sytuacji z rezerwacją (notifyExternalService)

Za pomocą tej metody poinformujesz serwis zewnętrzny o zaistniałej sytuacji w rezerwacji. Obecnie na takie informowanie pozwala Booking.com. Tak samo jak w panelu IdoSell Booking do wykorzystania jest informacja o błędnych danych karty płatniczej oraz niepojawieniu się gościa. Efektem przesłania takich informacji do Booking.com, jest reakcja i kontakt serwisu z gościem w zgłoszonej sprawie.

Bramka API Clients

Zrównaliśmy i uporządkowaliśmy bramkę API Clients odpowiedzialną za zarządzanie danymi dotyczącymi klientów składających rezerwacje. Od teraz wszelkie dane i opcje, które występują na stronie Klienci / Lista klientów, dostępne są również z poziomu API. W bramce API Clients znajdziesz metody odpowiedzialne za:

add - dodanie klientów oraz powiązanych z kontem gości upoważnionych do odbioru rezerwacji
delete - usuwanie klientów oraz powiązane z kontem dane gości
edit - edycję danych klienta i jego gości
get - pobieranie informacji o kliencie i jego gościach
history - pobieranie historii zmian danych klienta

Ponadto dla powyższych metod dodaliśmy pola tj. stan konta (aktywne, zablokowane), notatka o kliencie, rabat naliczany do rezerwacji nieobjętych promocją, rabat naliczany do rezerwacji objętych promocją, dane do faktury. Dodaliśmy też odpowiednią walidację w API oraz zaktualizowaliśmy dokumentację tejże bramki.

Nowe bramki API

Dodatkowo postanowiliśmy dodać do API zupełnie nowe bramki - dla obsługi płatności (Payments) oraz wystawiania dokumentów (ReservationsDocuments).

Bramka API Payments (Płatności)

Bramka Payments odpowiedzialna jest za zarządzanie płatnościami w rezerwacjach. Zarządzanie płatnościami dotyczy każdego elementu z tym związanego tj. wpłaty, przedpłaty, zwrotu i opłaty manipulacyjnej, zgodnie z widokiem który znasz z karty rezerwacji.

Wśród dostępnych metod bramki znajdziesz takie jak:

add - pozwala na dodawanie wpłat do rezerwacji
cancel - pozwala na anulację wpłat dla rezerwacji
confirm - pozwala na potwierdzenie wpłat dla rezerwacji
edit - pozwala na edytowanie wpłat dla rezerwacji
get - pozwala na pobieranie wpłat dla rezerwacji
getPaymentForms - pozwala na pobranie listy form płatności dostępnych w panelu administracyjnym

Bramka API ReservationsDocuments (Wystawianie dokumentów)

W bramce ReservationsDocuments znajdziesz metody, za pomocą których możesz zarządzać dokumentami danej rezerwacji. Obecnie są to faktury VATi pro forma. Wśród metod znajdziesz:

createDocuments - pozwala na wystawienie dokumentu do rezerwacji
editDocuments - pozwala na edytowanie dokumentu do rezerwacji
cancelDocuments - pozwala na anulowanie dokumentu do rezerwacji
getDocuments - pozwala na pobranie informacji o dokumentach wystawionych do rezerwacji w panelu administracyjnym

Serdecznie zachęcamy do zapoznania się z najnową wersją dokumentacji API i korzystania z niej.