Kalendář
Váš rozvrh, rezervační stránky a služby.
Calendar má veřejné metody pro obě strany rezervace. Některé jednají za vás, vlastníka, a berou váš klíč API: čtou vaše nastavení a rezervace, nastavují zdroje, služby a stránky, drží a potvrzují čas, ruší a mění tarif. Jiné jsou ty, které rezervační stránka volá pro návštěvníka. Nepotřebují klíč, jen klíč stránky.
Sdílení kalendářů s jinými lidmi, zobrazení, úkoly, celodenní události a Nastavení kalendáře se dělají v dashboardu. Dnes pro ně neexistuje veřejná metoda.
Pošlete požadavek metodě se svým klíčem:
Dobrá odpověď má code 1. Změna, kterou váš tarif nezahrnuje, je odmítnuta s code -62 a větou v data, například že skupinové schůzky potřebují Growth nebo že váš tarif pojme určitý počet rezervačních stránek. Chcete-li jednat s kalendářem účtu, který vám ho sdílel na úrovni úprav, předejte jeho share_id metodám, které ho berou.
Čtení nastavení a rezervací
get_calendar_setupodpoví jedním voláním na vše, co obrazovky Calendar kreslí: rezervovatelné osoby a místnosti s jejich hodinami, služby a zveřejněné rezervační stránky s jejich veřejnými adresami.get_calendar_bookingsvypisuje rezervace, ve výchozím stavu nadcházející. Předejtepastnastavené natruepro ty, které už proběhly, od nejnovější, alimitpro jejich počet. Každý řádek nese čas v pásmu zdroje, údaje hosta a vše, co řekl při rezervaci.get_calendar_slotsvypisuje rezervovatelné časy jedné služby u jednoho zdroje mezifrom_tsato_ts(epoch milisekundy), bez všeho, co je již obsazeno.
Nastavení toho, co lze rezervovat
save_calendar_resourcevytvoří nebo aktualizuje něco, co lze rezervovat: osobu, místnost, křeslo nebo zařízení. Potřebujetimezone, pásmo IANA jakoAsia/Jerusalem, a jeho hodiny se čtou v tomto pásmu. Vynechejteresource_id, chcete-li vytvořit nový.save_calendar_servicevytvoří nebo aktualizuje to, co si lidé mohou rezervovat: délku, rezervy, předstih, jak daleko dopředu lze rezervovat, místa, kde se schází (meeting_kind) a, pomocíprice_cents,currencyacheckout, kolik stojí a zda se platí při rezervaci. Více než jedno místo potřebuje tarif, který zahrnuje skupinové schůzky, a přijímání plateb potřebuje tarif, který zahrnuje platby.save_calendar_pagevytvoří nebo aktualizuje rezervační stránku: jejítitle,intro,service_ids, které nabízí, zda jeenabled, její barvuaccent, jejíbg_coloratext_color(každé#rrggbb, nebo prázdné, aby ji stránka odvodila ze zvýraznění),show_host, zda návštěvníci mohou měnit svou rezervaci (visitor_changes,change_hours,refund_percent) a finanční účet, na který se platí (finance_account_id). Vytvoření stránky nad limit stránek vašeho tarifu je odmítnuto.delete_calendar_itemodebere zdroj, službu nebo stránku podleitem_id. Rezervace se takto nikdy nemažou: ruší se.
Rezervace času sami
Rezervace z vlastního kódu má dva kroky, takže se jeden čas nikdy neprodá dvakrát.
Podržte čas
hold_calendar_slot rezervuje čas na několik minut. Předejte resource_id, service_id a start_utc (epoch milisekundy). Dobrá odpověď má data s occ_id, hold_token a expires_at. Pošlete idem_key, aby opakování volání vrátilo stejné podržení místo druhého místa.
Potvrďte ho
confirm_calendar_booking změní podržení na rezervaci. Předejte occ_id a hold_token z podržení a name, email, phone a note hosta. Podržení, které už neexistuje, o čas přišlo a je odmítnuto.
Změna rezervace
cancel_calendar_bookingruší podlebooking_ida vrací čas na veřejnou mřížku. Je bezpečné ji zavolat dvakrát. Jen uvolní čas: nepošle hostovi e-mail ani nevrátí platbu, což dělá Zrušit schůzku v dashboardu pro hosta, který rezervoval přes vaši stránku.notify_calendar_guestspošle e-mail všem pozvaným na jednu rezervaci, každému jednu zprávu, s přiloženým pozváním do kalendáře a volitelnoumessagedo 2000 znaků.kindjeinvitepro novou schůzku aupdatepro změnu, což je výchozí. E-mail přichází z vaší vlastní poštovní schránky v tarifu, který ji zahrnuje, a jinak z rezervační adresy Xuda, s vaší adresou jako adresou pro odpověď.create_booking_roomvytvoří místnost Xuda Meet pro potvrzenou video rezervaci, která žádnou nemá, a pošle každému hostovi odkaz.
Co volá rezervační stránka
Rezervační stránka pracuje se svým klíčem stránky, <uid>.<page_id>, a bez účtu.
get_booking_bootstrapodpoví na to, co stránka potřebuje k vykreslení: její název, služby a čerstvý protibotový token.get_public_booking_slotsvypisuje časy, které může návštěvník zvolit, každý se začátkem, koncem a počtem míst. Nikdy neříká, kdo drží ostatní místa.public_book_slotpřijme rezervaci od návštěvníka. Předejtepage_key,service_id,start_utc,tokenanameaemailnávštěvníka. Přidejteidem_key, aby dvojí stisknutí nerezervovalo dvakrát.company_websiteje past na boty: nechte ho prázdné.- U služby, která se platí při rezervaci,
public_start_paid_bookingpodrží čas a zahájí platbu,start_booking_paymentpošle podržený čas do Stripe apublic_confirm_paid_bookingaconfirm_paid_bookingji zarezervují, jakmile platba projde. Platba se před jakoukoli rezervací načte zpět ze Stripe. - Návštěvník spravuje rezervaci ze soukromého odkazu ve svém e-mailu.
get_public_booking,public_cancel_bookingandpublic_reschedule_bookingberou klíč stránky a hodnotumanagetoho odkazu. Řídí se pravidly stránky: zda smějí návštěvníci rezervaci měnit a do kolika hodin před začátkem. Zaplacená rezervace se nejdřív vrací podle procenta vrácení stránky.
Tarif
get_calendar_plans odpoví čtyřmi stupni s jejich cenami a tím, co každý nese, na kterém tarifu jste a zda je Calendar zapnutý. calendar_set_plan ho zapne, změní stupeň nebo ho vypne: předejte plan_id jako calendar_free, calendar_starter, calendar_growth nebo calendar_business, nebo nastavte deactivate na true. Viz Tarify a fakturace.