Kalendár
Váš rozvrh, rezervačné stránky a služby.
Calendar má verejné metódy pre obe strany rezervácie. Niektoré konajú za vás, vlastníka, a berú váš API kľúč: čítajú vaše nastavenie a rezervácie, nastavujú zdroje, služby a stránky, zadržia a potvrdia čas, rušia a menia plán. Ostatné sú tie, ktoré robí rezervačná stránka pre návštevníka. Nepotrebujú kľúč, len kľúč stránky.
Zdieľanie kalendárov s inými ľuďmi, zobrazenia, úlohy, celodenné udalosti a Nastavenia kalendára sa robia v dashboarde. Dnes pre ne neexistuje verejná metóda.
Pošlite požiadavku metóde so svojím kľúčom:
Dobrá odpoveď má code 1. Zmena, ktorú váš plán nezahŕňa, sa odmietne s code -62 a vetou v data, napríklad že skupinové relácie potrebujú Growth alebo že váš plán obsahuje určitý počet rezervačných stránok. Ak chcete konať v kalendári účtu, ktorý vám ho zdieľal na úrovni úprav, odovzdajte jeho share_id metódam, ktoré ho berú.
Čítajte nastavenie a rezervácie
get_calendar_setupodpovie na všetko, čo obrazovky Calendar kreslia, jedným volaním: osoby a miestnosti, ktoré sa dajú rezervovať, s ich hodinami, služby a zverejnené rezervačné stránky s ich verejnými adresami.get_calendar_bookingsvypisuje rezervácie, predvolene nadchádzajúce. Odovzdajtepastnastavené natruepre tie, ktoré už prebehli, od najnovších, alimitpre ich počet. Každý riadok nesie čas v pásme zdroja, údaje hosťa a všetko, čo pri rezervácii povedal.get_calendar_slotsvypisuje rezervovateľné časy jednej služby na jednom zdroji medzifrom_tsato_ts(epoch v milisekundách), bez všetkého, čo je už obsadené.
Nastavte, čo sa dá rezervovať
save_calendar_resourcevytvorí alebo aktualizuje niečo, čo sa dá rezervovať: osobu, miestnosť, stoličku alebo zariadenie. Potrebujetimezone, zónu IANA akoAsia/Jerusalem, a jej hodiny sa čítajú v tejto zóne. Vynechajteresource_id, aby ste vytvorili nový.save_calendar_servicevytvorí alebo aktualizuje, čo si ľudia môžu rezervovať: jeho dĺžku, rezervy, predstih, ako ďaleko dopredu sa dá rezervovať, miesta, kde sa stretávajú (meeting_kind) a pomocouprice_cents,currencyacheckout, koľko stojí a či sa platí pri rezervácii. Viac ako jedno miesto vyžaduje plán, ktorý zahŕňa skupinové relácie, a prijímanie platieb vyžaduje plán, ktorý zahŕňa platby.save_calendar_pagevytvorí alebo aktualizuje rezervačnú stránku: jejtitle,intro,service_ids, ktoré ponúka, či jeenabled, jej farbuaccent, jejbg_coloratext_color(každá#rrggbb, alebo prázdna, aby ju stránka odvodila z akcentu),show_host, či návštevníci môžu meniť svoju rezerváciu (visitor_changes,change_hours,refund_percent) a finančný účet, na ktorý sa platí (finance_account_id). Vytvorenie stránky nad limit stránok vášho plánu sa odmietne.delete_calendar_itemodstráni zdroj, službu alebo stránku podľaitem_id. Rezervácie sa takto nikdy nemažú: rušia sa.
Rezervujte čas sami
Rezervácia z vlastného kódu má dva kroky, aby sa jeden čas nikdy nepredal dvakrát.
Zadržte čas
hold_calendar_slot rezervuje čas na niekoľko minút. Odovzdajte resource_id, service_id a start_utc (epoch v milisekundách). Dobrá odpoveď má data s occ_id, hold_token a expires_at. Pošlite idem_key, aby opakované volanie vrátilo to isté zadržanie namiesto zabratia druhého miesta.
Potvrďte ho
confirm_calendar_booking zmení zadržanie na rezerváciu. Odovzdajte occ_id a hold_token zo zadržania a name, email, phone a note hosťa. Zadržanie, ktoré už neexistuje, stratilo čas a odmietne sa.
Zmeňte rezerváciu
cancel_calendar_bookingzruší podľabooking_ida vráti čas na verejnú mriežku. Je bezpečné zavolať ho dvakrát. Iba uvoľní čas: neposiela hosťovi e-mail ani nevracia platbu, čo robí Zrušiť stretnutie v dashboarde pre hosťa, ktorý rezervoval cez vašu stránku.notify_calendar_guestspošle e-mail všetkým pozvaným na jednu rezerváciu, po jednej správe každému, s kalendárovou pozvánkou v prílohe a voliteľnoumessagedo 2000 znakov.kindjeinvitepre nové stretnutie aupdatepre zmenu, čo je predvolené. E-mail prichádza z vašej vlastnej schránky na pláne, ktorý ju zahŕňa, a inak z rezervačnej adresy Xuda, s vašou adresou ako adresou pre odpoveď.create_booking_roomvytvorí miestnosť Xuda Meet potvrdenej video rezervácie, ktorá ju nemá, a pošle každému hosťovi odkaz.
Čo volá rezervačná stránka
Rezervačná stránka funguje s kľúčom stránky, <uid>.<page_id>, a bez účtu.
get_booking_bootstrapodpovie, čo stránka potrebuje na vykreslenie: jej názov, služby a čerstvý token proti botom.get_public_booking_slotsvypisuje časy, ktoré môže návštevník vybrať, každý so začiatkom, koncom a počtom miest. Nikdy nepovie, kto drží ostatné miesta.public_book_slotprijme rezerváciu od návštevníka. Odovzdajtepage_key,service_id,start_utc,tokenanameaemailnávštevníka. Pridajteidem_key, aby dvojité stlačenie nerezervovalo dvakrát.company_websiteje pasca na boty: nechajte ho prázdne.- Pre službu, ktorá sa platí pri rezervácii,
public_start_paid_bookingzadrží čas a spustí platbu,start_booking_paymentpošle zadržaný čas do Stripe apublic_confirm_paid_bookingaconfirm_paid_bookingho rezervujú, keď platba prebehla. Platba sa prečíta späť zo Stripe skôr, než sa čokoľvek rezervuje. - Návštevník spravuje rezerváciu zo súkromného odkazu vo svojom e-maile.
get_public_booking,public_cancel_bookingapublic_reschedule_bookingberú kľúč stránky a hodnotumanagez tohto odkazu. Riadia sa pravidlami stránky: či smú návštevníci meniť rezerváciu a do koľkých hodín pred jej začiatkom. Platená rezervácia sa najprv vráti podľa percenta refundácie stránky.
Plán
get_calendar_plans odpovie štyrmi úrovňami s cenami a tým, čo každá nesie, ktorý plán máte a či je Calendar zapnutý. calendar_set_plan ho zapne, zmení úroveň alebo vypne: odovzdajte plan_id ako calendar_free, calendar_starter, calendar_growth alebo calendar_business, alebo nastavte deactivate na true. Pozrite Plány a fakturácia.