Calendar
לוח הזמנים שלכם, עמודי הזמנה ושירותים.
ל-Calendar יש שיטות ציבוריות לשני הצדדים של פגישה. חלקן פועלות עבורכם, הבעלים, ומקבלות את מפתח ה-API שלכם: הן קוראות את ההגדרה והפגישות שלכם, מגדירות משאבים, שירותים ועמודים, מחזיקות ומאשרות זמן, מבטלות ומשנות את התוכנית. אחרות הן אלה שעמוד קביעת תורים מבצע עבור מבקר. הן לא צריכות מפתח, רק את המפתח של העמוד.
שיתוף יומנים עם אנשים אחרים, התצוגות, המשימות, אירועי היום והגדרות היומן נעשים בדשבורד. אין להם היום שיטה ציבורית.
שולחים בקשה לשיטה עם המפתח שלכם:
לתשובה טובה יש code 1. שינוי שהתוכנית שלכם לא כוללת נדחה עם code -62 ומשפט ב-data, למשל שמפגשים קבוצתיים דורשים Growth או שהתוכנית שלכם מחזיקה מספר של עמודי קביעת תורים. כדי לפעול על היומן של חשבון ששיתף אותו איתכם ברמת עריכה, מעבירים את ה-share_id שלו לשיטות שמקבלות אחד.
קוראים את ההגדרה והפגישות שלכם
get_calendar_setupעונה בקריאה אחת על כל מה שמסכי Calendar מציירים: האנשים והחדרים שאפשר לקבוע, עם השעות שלהם, השירותים, ועמודי קביעת התורים שפורסמו עם הכתובות הציבוריות שלהם.get_calendar_bookingsמפרטת פגישות, הקרובות כברירת מחדל. מעביריםpastשמוגדר ל-trueלאלה שכבר קרו, החדשות ראשונות, ו-limitלכמה. כל שורה נושאת את הזמן באזור של המשאב, את פרטי האורח ואת כל מה שאמר כשקבע.get_calendar_slotsמפרטת את הזמנים שאפשר לקבוע של שירות אחד במשאב אחד ביןfrom_tsל-to_ts(אלפיות שנייה מאז epoch), בלי כל מה שכבר תפוס.
מגדירים מה אפשר לקבוע
save_calendar_resourceיוצרת או מעדכנת משהו שאפשר לקבוע: אדם, חדר, כיסא או מכשיר. היא צריכהtimezone, אזור IANA כמוAsia/Jerusalem, והשעות שלה נקראות באזור הזה. משמיטים אתresource_idכדי ליצור חדש.save_calendar_serviceיוצרת או מעדכנת מה שאנשים יכולים לקבוע: המשך שלו, מרווחים, התראה מראש, כמה רחוק קדימה אפשר לקבוע, מקומות, איפה נפגשים (meeting_kind), ועםprice_cents,currencyו-checkout, כמה הוא עולה והאם משלמים בקביעה. יותר ממקום אחד דורש תוכנית שכוללת מפגשים קבוצתיים, וגביית תשלום דורשת תוכנית שכוללת תשלומים.save_calendar_pageיוצרת או מעדכנת עמוד קביעת תורים: ה-titleשלו,intro, ה-service_idsשהוא מציע, האם הואenabled, צבע ה-accentשלו,show_host, האם מבקרים יכולים לשנות את הפגישה שלהם (visitor_changes,change_hours,refund_percent) והחשבון הפיננסי שהתשלום מגיע אליו (finance_account_id). יצירת עמוד מעבר למגבלת העמודים של התוכנית שלכם נדחית.delete_calendar_itemמסירה משאב, שירות או עמוד לפיitem_id. פגישות אף פעם לא נמחקות כך: הן מבוטלות.
קובעים זמן בעצמכם
קביעה מהקוד שלכם היא שני שלבים, כך שזמן אחד אף פעם לא נמכר פעמיים.
מחזיקים את הזמן
hold_calendar_slot שומרת זמן לכמה דקות. מעבירים resource_id, service_id ו-start_utc (אלפיות שנייה מאז epoch). לתשובה טובה יש data עם occ_id, hold_token ו-expires_at. שולחים idem_key כדי שחזרה על הקריאה תחזיר את אותה החזקה במקום לקחת מקום שני.
מאשרים אותו
confirm_calendar_booking הופכת את ההחזקה לפגישה. מעבירים את ה-occ_id ואת ה-hold_token מההחזקה, ואת ה-name, ה-email, ה-phone וה-note של האורח. החזקה שכבר לא קיימת איבדה את הזמן ונדחית.
משנים פגישה
cancel_calendar_bookingמבטלת לפיbooking_idומחזירה את הזמן לרשת הציבורית. בטוח לקרוא לה פעמיים. היא רק משחררת את הזמן: היא לא שולחת אימייל לאורח ולא מחזירה תשלום, מה שביטול הפגישה בדשבורד עושה לאורח שקבע דרך העמוד שלכם.notify_calendar_guestsשולחת אימייל לכל המוזמנים לפגישה אחת, הודעה אחת לכל אחד, עם הזמנת היומן מצורפת ו-messageאופציונלי של עד 2000 תווים.kindהואinviteלפגישה חדשה ו-updateלשינוי, שהוא ברירת המחדל. האימייל יוצא מתיבת הדואר שלכם בתוכנית שכוללת אותה, ומכתובת הקביעה של Xuda אחרת, עם הכתובת שלכם כ-reply-to.create_booking_roomיוצרת את חדר Xuda Meet של פגישת וידאו מאושרת שאין לה אחד, ושולחת לכל אורח את הקישור.
מה עמוד קביעת תורים קורא
עמוד קביעת תורים עובד עם מפתח העמוד שלו, <uid>.<page_id>, ובלי חשבון.
get_booking_bootstrapעונה על מה שעמוד צריך כדי לצייר את עצמו: הכותרת שלו, השירותים שלו וטוקן אנטי-בוט טרי.get_public_booking_slotsמפרטת את הזמנים שמבקר יכול לבחור, כל אחד עם התחלה, סיום וספירת מקומות. היא אף פעם לא אומרת מי מחזיק את המקומות האחרים.public_book_slotמקבלת פגישה ממבקר. מעבירים את ה-page_key,service_id,start_utc, ה-token, ואת ה-nameוה-emailשל המבקר. מוסיפיםidem_keyכדי שלחיצה כפולה לא תקבע פעמיים.company_websiteהוא מלכודת לבוטים: משאירים אותו ריק.- לשירות שמשלמים עליו בקביעה,
public_start_paid_bookingמחזיקה את הזמן ומתחילה את התשלום,start_booking_paymentשולחת זמן מוחזק ל-Stripe, ו-public_confirm_paid_bookingו-confirm_paid_bookingקובעות אותו ברגע שהתשלום עבר. התשלום נקרא בחזרה מ-Stripe לפני שנקבע משהו. - מבקר מנהל פגישה מהקישור הפרטי באימייל שלו.
get_public_booking,public_cancel_bookingו-public_reschedule_bookingמקבלות את מפתח העמוד ואת הערךmanageשל הקישור הזה. הן עוקבות אחרי הכללים של העמוד: האם מבקרים רשאים לשנות פגישה, ועד כמה שעות לפני שהיא מתחילה. פגישה ששולמה מוחזרת קודם, לפי אחוז ההחזר של העמוד.
התוכנית
get_calendar_plans עונה על ארבע הדרגות עם המחירים שלהן ומה כל אחת נושאת, באיזו תוכנית אתם והאם Calendar מופעל. calendar_set_plan מפעילה אותו, משנה את הדרגה או מכבה אותו: מעבירים plan_id כ-calendar_free, calendar_starter, calendar_growth או calendar_business, או מגדירים deactivate ל-true. ראו תוכניות וחיוב.