Ημερολόγιο
Το πρόγραμμά σας, οι σελίδες κρατήσεων και οι υπηρεσίες.
Το Calendar έχει δημόσιες μεθόδους για τις δύο πλευρές μιας κράτησης. Κάποιες ενεργούν για εσάς, τον ιδιοκτήτη, και παίρνουν το κλειδί API σας: διαβάζουν τη ρύθμισή σας και τις κρατήσεις σας, ρυθμίζουν πόρους, υπηρεσίες και σελίδες, δεσμεύουν και επιβεβαιώνουν μια ώρα, ακυρώνουν και αλλάζουν το πλάνο. Άλλες είναι αυτές που κάνει μια σελίδα κρατήσεων για έναν επισκέπτη. Δεν χρειάζονται κλειδί, μόνο το κλειδί της σελίδας.
Η κοινή χρήση ημερολογίων με άλλους ανθρώπους, οι προβολές, οι εργασίες, τα ημερήσια συμβάντα και οι Ρυθμίσεις Calendar γίνονται στον πίνακα ελέγχου. Σήμερα δεν έχουν δημόσια μέθοδο.
Στείλτε ένα αίτημα σε μια μέθοδο με το κλειδί σας:
Μια καλή απάντηση έχει 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, ταbg_colorκαιtext_color(το καθένα#rrggbb, ή κενό για να τα φτιάξει η σελίδα από το χρώμα έμφασης), το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και επιστρέφει την ώρα στο δημόσιο πλέγμα. Είναι ασφαλές να κληθεί δύο φορές. Μόνο ελευθερώνει την ώρα: δεν στέλνει email στον καλεσμένο ούτε επιστρέφει πληρωμή, πράγματα που κάνει το Ακύρωση ραντεβού του πίνακα ελέγχου για έναν καλεσμένο που έκλεισε μέσω της σελίδας σας. - Το
notify_calendar_guestsστέλνει email σε όλους τους προσκεκλημένους μιας κράτησης, ένα μήνυμα στον καθένα, με συνημμένη την πρόσκληση ημερολογίου και ένα προαιρετικόmessageέως 2000 χαρακτήρες. Τοkindείναιinviteγια ένα νέο ραντεβού καιupdateγια μια αλλαγή, που είναι η προεπιλογή. Το email έρχεται από το δικό σας γραμματοκιβώτιο σε πλάνο που το περιλαμβάνει, και αλλιώς από τη διεύθυνση κρατήσεων του Xuda, με τη δική σας διεύθυνση ως reply-to. - Το
create_booking_roomδημιουργεί την αίθουσα Xuda Meet μιας επιβεβαιωμένης κράτησης βίντεο που δεν έχει, και στέλνει σε κάθε καλεσμένο τον σύνδεσμο.
Τι καλεί μια σελίδα κρατήσεων
Μια σελίδα κρατήσεων λειτουργεί με το κλειδί της σελίδας της, <uid>.<page_id>, και χωρίς λογαριασμό.
- Το
get_booking_bootstrapαπαντά με ό,τι χρειάζεται μια σελίδα για να σχεδιαστεί: τον τίτλο της, τις υπηρεσίες της και ένα φρέσκο token κατά των bots. - Το
get_public_booking_slotsαπαριθμεί τις ώρες που μπορεί να επιλέξει ένας επισκέπτης, καθεμία με αρχή, τέλος και αριθμό θέσεων. Δεν λέει ποτέ ποιος κρατά τις άλλες θέσεις. - Το
public_book_slotπαίρνει μια κράτηση από έναν επισκέπτη. Περάστε τοpage_key, τοservice_id, τοstart_utc, τοtoken, και ταnameκαιemailτου επισκέπτη. Προσθέστε έναidem_keyώστε ένα διπλό πάτημα να μη κλείσει δύο φορές. Τοcompany_websiteείναι παγίδα για bots: αφήστε το κενό. - Για μια υπηρεσία που πληρώνεται κατά την κράτηση, το
public_start_paid_bookingδεσμεύει την ώρα και ξεκινά την πληρωμή, τοstart_booking_paymentστέλνει μια δεσμευμένη ώρα στο Stripe, και ταpublic_confirm_paid_bookingκαιconfirm_paid_bookingτην κλείνουν μόλις εκκαθαριστεί η πληρωμή. Η πληρωμή διαβάζεται πίσω από το Stripe πριν κλειστεί οτιδήποτε. - Ένας επισκέπτης διαχειρίζεται μια κράτηση από τον ιδιωτικό σύνδεσμο στο email του. Τα
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. Δείτε Πλάνα και χρέωση.