Zobacz specyfikację
Transkrypt
Zobacz specyfikację
Specyfikacja API mbooking Punkty dostępowe Zapytania do API mogą być wywoływane zarówno metoda GET jak i POST Pobieranie informacji: http://mbooking.pl/api/json/get/ Zapisywanie informacji http://mbooking.pl/api/json/post/ Uwierzytelnienie Każde zapytanie do API wymaga uwierzytelnienia na podstawie przypisanego adresu email do konta firmy oraz hasła. Nazwa przekazywanych parametrów: o email – adres email użytkownika firmy o password – hasło użytkownika firmy o metod – wywołanie metody Kodowanie znaków Każdy string pobierany z API jest kodowany jako UTF-8. Obsługiwany format znaków System obsługuje format JSON. Każde zapytanie zwraca odpowiedź. W przypadku braku autoryzacji lub błędnych parametrów system zwraca komunikat w formie json: {"error":true,"error_code":number}. Dostępne metody o get_offer – pobiera dostępny katalog branż obsługiwanych przez system. Opis parametrów: category_id – ID kategorii ofertowej category_name – Nazwa kategorii ofertowej o get_company_offer – pobiera aktywną ofertę danej firmy. Opis parametrów: category_id – ID kategorii ofertowej category_name – Nazwa kategorii ofertowej o get_departments - pobiera działy i departamenty danej firmy. Opis parametrów: dep_id – ID departamentu lub działu. parent_id – ID rodzica danego rekordu. name – Nazwa departamentu lub działu. active – Parametr określający aktywność danego działu lub departamentu. position – liczba porządkowa danej kategorii. o get_employee – pobiera listę pracowników danej firmy. Opis parametrów: employee_id – Przypisane ID pracownika email – adres email pracownika. name - Imię lastname – Nazwisko. Desc – Opis. Strona 1 z 5 Nip – Numer NIP pracownika. Pesel – Numer PESEL pracownika. powers – Uprawnienia pracownika. City – Miasto. Street – Nazwa ulicy. no_home – numer domu no_fat – numer lokalu code – kod pocztowy. status – Status konta danego pracownika. point_of_services – lista punktów usługowych przypisanych do danego pracownika point_id – ID punktu usługowego przypisanego do pracownika. point_name – Nazwa punktu usługowego przypisanego do pracownika. o get_point_of_service – pobiera listę dostępnych punktów usługowych danej firmy. Opis parametrów: point_id – ID punktu usługowego. name_of_point – Nazwa punktu usługowego. desc – Opis punktu usługowego. activate – Aktywność punktu usługowego. o get_services – pobiera listę ofert danej firmy. Opis parametrów: service_id – ID usługi offer_id – ID oferty firmy do której przypisana została usługa. department_id – ID departamentu do którego usługa została przypisana type – typ rezerwacji (rezerwacja / rejestracja / abonament) name – Nazwa usługi. Description – Opis usługi Price – Kwota usługi. Discount – Przecena z Limit – Limit iliściowy limit_time_type - Typ limitu czasowego (bez limitu, liczba dni, przedział czasowy) limit_days - Limit czasowy w ramach abonamentu liczony w dniach subscription_start – Poczatek okresu abonamentowego subscription_end - Koniec okresu abonamentowego limit_sep – Parametr określający czy limit usług ma zostać równo podzielony względem limitu czasowego (bez podziału, równo). deposit – Płatność jednorazowa note – Notatka firmy przy usłudze active – status aktywnosci Strona 2 z 5 limit_period_time - Limit w zadanym okresie (bez limitu, dzienny, tygodniowy, miesięczny) limit_period - Limit w zadanym okresie no_opinions – liczba opinii użytkowników serwisu opinion – średnia opinia rank – Ranking systemowy no_clicks – liczba kliknięć valid – ważność oferty o get_customers – pobiera listę klientów firmy. Opis parametrów: agree_reg – potwierdzenie zgody na regulamin agree_mark – potwierdzenie zgody na przesyłanie treści marketingowych date_reg – data rejestracji email – adres email name – imię klinta last_name – nazwisko klienta sex - płeć city - miasto Tel - telefon date_of_birth – data urodzenia note – notatka firmy o get_reservations – pobiera aktualną listę rezerwacji danej firmy. Opis parametrów: reserve_id – ID rezerwacji serviced – ID usługi amount – cena usługi consumentName - nazwa klienta virtualGiftCode – Parametr określający czy rezerwacja jest karta podarunkową paymentType – typ płatności paymentStatus – status płatnosci status – status wykupionej usługi date – data rezerwacji usługi noInQueue – numer w kolejce currentNo – aktualnie obsługiwany numerek w kolejce noOfPeople – liczba oczekujących w kolejce avgTime – średni czas usługi avgTimeTill – pozostały czas do realizacji usługi limitNo – Limit do abonamentu limitNoUsed – liczba wykorzystanych wejść limitInPeriod – limit w zadanym okresie czasowym limitNoPeriod – pozostaly limit w zadanym okresie limitDayStart – Początek abonamentu Strona 3 z 5 limitDayEnd – Koniec abonamentu o add_company_offer– dodanie oferty firmy Opis parametrów: category_id – ID kategorii ofertowej o add_department– dodanie działu lub departamentu firmy. Opis parametrów: name – Nazwa działu lub departamentu position – liczba porządkowa w strukturze drzewa parent_id – id rodzica w strukturze drzewa. o add_employee – Dodanie nowego pracownika firmy. Opis parametrów: email – email pracownika password – hasło do konta pracownika name - imię lastname - nazwisko desc – opis stanowiska nip – Numer NIP pracownika pesel – Numer PESEL pracownika powers – Uprawnienia pracownika city- Miasto street - Ulica no_home – nr. dmu no_fat – nr. mieszcania code – kod pocztowy status – Status aktywności konta o add_point_of_service – dodanie punktu usługowego. Opis parametrów: name_of_point – Nazwa punktu usługowego desc – Opis punktu o add_ service – dodanie usługi. Opis parametrów: offer_id – ID oferty firmy do której przypisana została usługa. department_id – ID departamentu do którego usługa została przypisana type – typ rezerwacji (rezerwacja / rejestracja / abonament) name – Nazwa usługi. Description – Opis usługi Price – Kwota usługi. Discount – Przecena z Limit – Limit iliściowy Strona 4 z 5 o limit_time_type - Typ limitu czasowego (bez limitu, liczba dni, przedział czasowy) limit_days - Limit czasowy w ramach abonamentu liczony w dniach subscription_start – Poczatek okresu abonamentowego subscription_end - Koniec okresu abonamentowego limit_sep – Parametr określający czy limit usług ma zostać równo podzielony względem limitu czasowego (bez podziału, równo). deposit – Płatność jednorazowa note – Notatka firmy przy usłudze active – status aktywnosci limit_period_time - Limit w zadanym okresie (bez limitu, dzienny, tygodniowy, miesięczny) limit_period - Limit w zadanym okresie valid – ważność oferty add_reservation – dodanie rezerwacji. Opis parametrów: serviced – ID usługi amount – cena usługi consumentName - nazwa klienta virtualGiftCode – Parametr określający czy rezerwacja jest karta podarunkową paymentType – typ płatności paymentStatus – status płatnosci status – status wykupionej usługi date – data rezerwacji usługi noInQueue – numer w kolejce currentNo – aktualnie obsługiwany numerek w kolejce noOfPeople – liczba oczekujących w kolejce avgTime – średni czas usługi avgTimeTill – pozostały czas do realizacji usługi limitNo – Limit do abonamentu limitNoUsed – liczba wykorzystanych wejść limitInPeriod – limit w zadanym okresie czasowym limitNoPeriod – pozostaly limit w zadanym okresie limitDayStart – Początek abonamentu limitDayEnd – Koniec abonamentu Kody błędów o 200 – (OK) Zapytanie zostało wykonane poprawnie . o 201 – (Created) Zasób został utworzony poprawnie. o 400 – (Bad Reguest) Któryś z parametrów ma błędną wartość. o 401 – (Unauthorized) Błąd autoryzacji. o 402 – (Not Found) Zasób nie został odnaleziony Strona 5 z 5