Kalendarz
Twój grafik, strony rezerwacji i usługi.
Calendar ma publiczne metody dla obu stron rezerwacji. Jedne działają dla Ciebie, właściciela, i przyjmują Twój klucz API: odczytują konfigurację i rezerwacje, ustawiają zasoby, usługi i strony, wstrzymują i potwierdzają termin, anulują i zmieniają plan. Inne to te, które strona rezerwacji wykonuje dla odwiedzającego. Nie potrzebują klucza, tylko klucza strony.
Udostępnianie kalendarzy innym osobom, widoki, zadania, wydarzenia dnia i Ustawienia kalendarza odbywają się w dashboardzie. Nie mają dziś metody publicznej.
Wyślij żądanie do metody ze swoim kluczem:
Dobra odpowiedź ma code 1. Zmiana, której Twój plan nie obejmuje, jest odrzucana z code -62 i zdaniem w data, na przykład że sesje grupowe wymagają Growth albo że Twój plan mieści określoną liczbę stron rezerwacji. Aby działać na kalendarzu konta, które udostępniło go Tobie z prawem edycji, przekaż jego share_id metodom, które go przyjmują.
Odczytaj konfigurację i rezerwacje
get_calendar_setupodpowiada jednym wywołaniem na wszystko, co rysują ekrany Calendar: osoby i pokoje, które można rezerwować, wraz z godzinami, usługi i opublikowane strony rezerwacji z ich publicznymi adresami.get_calendar_bookingswyświetla rezerwacje, domyślnie nadchodzące. Przekażpastustawione natrue, aby dostać te, które już się odbyły, od najnowszych, orazlimitdla liczby. Każdy wiersz niesie czas w strefie zasobu, dane gościa i wszystko, co powiedział przy rezerwacji.get_calendar_slotswyświetla terminy do zarezerwowania jednej usługi na jednym zasobie międzyfrom_tsato_ts(milisekundy epoki), z pominięciem wszystkiego, co już zajęte.
Skonfiguruj to, co można zarezerwować
save_calendar_resourcetworzy lub aktualizuje coś, co można zarezerwować: osobę, pokój, fotel lub urządzenie. Wymagatimezone, strefy IANA, takiej jakAsia/Jerusalem, a jego godziny są czytane w tej strefie. Pomińresource_id, aby utworzyć nowy.save_calendar_servicetworzy lub aktualizuje to, co ludzie mogą zarezerwować: jego długość, bufory, wyprzedzenie, na ile dni naprzód można rezerwować, miejsca, gdzie się odbywa (meeting_kind) oraz, zprice_cents,currencyicheckout, ile kosztuje i czy jest płatne przy rezerwacji. Więcej niż jedno miejsce wymaga planu z sesjami grupowymi, a pobieranie płatności wymaga planu z płatnościami.save_calendar_pagetworzy lub aktualizuje stronę rezerwacji: jejtitle,intro, oferowaneservice_ids, czy jestenabled, jej koloraccent, jejbg_coloritext_color(każdy#rrggbbalbo pusty, aby strona wyprowadziła go z akcentu),show_host, czy odwiedzający mogą zmieniać swoją rezerwację (visitor_changes,change_hours,refund_percent) i konto finansowe, na które trafiają płatności (finance_account_id). Utworzenie strony ponad limit stron Twojego planu jest odrzucane.delete_calendar_itemusuwa zasób, usługę lub stronę wedługitem_id. Rezerwacje nigdy nie są w ten sposób usuwane: są anulowane.
Zarezerwuj termin samodzielnie
Rezerwacja z własnego kodu to dwa kroki, aby jeden termin nigdy nie został sprzedany dwa razy.
Wstrzymaj termin
hold_calendar_slot rezerwuje termin na kilka minut. Przekaż resource_id, service_id i start_utc (milisekundy epoki). Dobra odpowiedź ma data z occ_id, hold_token i expires_at. Wyślij idem_key, aby powtórzenie wywołania zwróciło to samo wstrzymanie zamiast zajmować drugie miejsce.
Potwierdź go
confirm_calendar_booking zamienia wstrzymanie w rezerwację. Przekaż occ_id i hold_token z wstrzymania oraz name, email, phone i note gościa. Wstrzymanie, którego już nie ma, straciło termin i jest odrzucane.
Zmień rezerwację
cancel_calendar_bookinganuluje wedługbooking_idi zwraca termin na publiczną siatkę. Można ją bezpiecznie wywołać dwa razy. Tylko zwalnia termin: nie wysyła e-maila do gościa ani nie zwraca płatności, co robi Anuluj spotkanie w dashboardzie dla gościa, który zarezerwował przez Twoją stronę.notify_calendar_guestswysyła e-mailem do wszystkich zaproszonych na jedną rezerwację, po jednej wiadomości, z załączonym zaproszeniem do kalendarza i opcjonalnymmessagedo 2000 znaków.kindtoinvitedla nowego spotkania iupdatedla zmiany, co jest wartością domyślną. E-mail pochodzi z Twojej własnej skrzynki w planie, który ją obejmuje, a w przeciwnym razie z adresu rezerwacji Xuda, z Twoim adresem jako adresem odpowiedzi.create_booking_roomtworzy pokój Xuda Meet dla potwierdzonej rezerwacji wideo, która go nie ma, i wysyła każdemu gościowi link.
Co wywołuje strona rezerwacji
Strona rezerwacji działa z kluczem strony, <uid>.<page_id>, i bez konta.
get_booking_bootstrapodpowiada tym, czego strona potrzebuje, aby się narysować: jej tytułem, usługami i świeżym tokenem antybotowym.get_public_booking_slotswyświetla terminy, które odwiedzający może wybrać, każdy z początkiem, końcem i liczbą miejsc. Nigdy nie mówi, kto zajmuje pozostałe miejsca.public_book_slotprzyjmuje rezerwację od odwiedzającego. Przekażpage_key,service_id,start_utc,tokenoraznameiemailodwiedzającego. Dodajidem_key, aby dwukrotne naciśnięcie nie zarezerwowało dwa razy.company_websiteto pułapka na boty: zostaw go pustym.- Dla usługi płatnej przy rezerwacji
public_start_paid_bookingwstrzymuje termin i rozpoczyna płatność,start_booking_paymentwysyła wstrzymany termin do Stripe, apublic_confirm_paid_bookingiconfirm_paid_bookingrezerwują go po zaksięgowaniu płatności. Płatność jest odczytywana ze Stripe, zanim cokolwiek zostanie zarezerwowane. - Odwiedzający zarządza rezerwacją z prywatnego linku w swoim e-mailu.
get_public_booking,public_cancel_bookingipublic_reschedule_bookingprzyjmują klucz strony i wartośćmanagez tego linku. Stosują się do reguł strony: czy odwiedzający mogą zmieniać rezerwację i do ilu godzin przed jej początkiem. Płatna rezerwacja jest najpierw zwracana, według procentu zwrotu strony.
Plan
get_calendar_plans odpowiada czterema poziomami z ich cenami i tym, co niesie każdy, jaki plan masz i czy Calendar jest włączony. calendar_set_plan włącza go, zmienia poziom albo wyłącza: przekaż plan_id jako calendar_free, calendar_starter, calendar_growth lub calendar_business albo ustaw deactivate na true. Zobacz Plany i rozliczenia.