Calendar
Il tuo programma, le pagine di prenotazione e i servizi.
Calendar ha metodi pubblici per i due lati di una prenotazione. Alcuni agiscono per te, il proprietario, e richiedono la tua chiave API: leggono la tua configurazione e le tue prenotazioni, configurano risorse, servizi e pagine, bloccano e confermano un orario, annullano e cambiano il piano. Altri sono quelli che una pagina di prenotazione fa per un visitatore. Non richiedono una chiave, solo la chiave della pagina.
La condivisione dei calendari con altre persone, le viste, le attività, gli eventi del giorno e le Impostazioni di Calendario si gestiscono nella dashboard. Oggi non hanno un metodo pubblico.
Invia una richiesta a un metodo con la tua chiave:
Una risposta valida ha code 1. Una modifica che il tuo piano non include viene rifiutata con code -62 e una frase in data, per esempio che le sessioni di gruppo richiedono Growth o che il tuo piano contiene un certo numero di pagine di prenotazione. Per agire sul calendario di un account che lo ha condiviso con te con livello di modifica, passa il suo share_id ai metodi che ne accettano uno.
Leggi la tua configurazione e le prenotazioni
get_calendar_setuprisponde in una sola chiamata a tutto ciò che disegnano le schermate di Calendar: le persone e le stanze prenotabili con i loro orari, i servizi e le pagine di prenotazione pubblicate con i loro indirizzi pubblici.get_calendar_bookingselenca le prenotazioni, per impostazione predefinita quelle future. Passapastimpostato sutrueper quelle già avvenute, le più recenti per prime, elimitper quante. Ogni riga porta l'orario nel fuso della risorsa, i dati dell'ospite e tutto ciò che ha detto prenotando.get_calendar_slotselenca gli orari prenotabili di un servizio su una risorsa trafrom_tseto_ts(millisecondi epoch), escludendo tutto ciò che è già occupato.
Configura ciò che si può prenotare
save_calendar_resourcecrea o aggiorna qualcosa che si può prenotare: una persona, una stanza, una poltrona o un dispositivo. Richiede untimezone, un fuso IANA comeAsia/Jerusalem, e i suoi orari vengono letti in quel fuso. Omettiresource_idper crearne una nuova.save_calendar_servicecrea o aggiorna ciò che le persone possono prenotare: la sua durata, i margini, il preavviso, con quanto anticipo si può prenotare, i posti, dove si svolge (meeting_kind) e, conprice_cents,currencyecheckout, quanto costa e se si paga al momento della prenotazione. Più di un posto richiede un piano che includa le sessioni di gruppo, e incassare pagamenti richiede un piano che includa i pagamenti.save_calendar_pagecrea o aggiorna una pagina di prenotazione: il suotitle,intro, gliservice_idsche offre, se èenabled, il suo coloreaccent,show_host, se i visitatori possono modificare la loro prenotazione (visitor_changes,change_hours,refund_percent) e il conto Finance su cui viene pagata (finance_account_id). Creare una pagina oltre il limite di pagine del tuo piano viene rifiutato.delete_calendar_itemrimuove una risorsa, un servizio o una pagina tramiteitem_id. Le prenotazioni non vengono mai eliminate in questo modo: vengono annullate.
Prenota tu un orario
Prenotare dal tuo codice richiede due passaggi, così un orario non viene mai venduto due volte.
Blocca l'orario
hold_calendar_slot riserva un orario per alcuni minuti. Passa resource_id, service_id e start_utc (millisecondi epoch). Una risposta valida ha data con occ_id, hold_token e expires_at. Invia un idem_key così una ripetizione della chiamata restituisce lo stesso blocco invece di prendere un secondo posto.
Confermalo
confirm_calendar_booking trasforma il blocco in una prenotazione. Passa occ_id e hold_token dal blocco, e name, email, phone e note dell'ospite. Un blocco che non esiste più ha perso l'orario e viene rifiutato.
Modifica una prenotazione
cancel_calendar_bookingannulla tramitebooking_ide rimette l'orario nella griglia pubblica. È sicuro chiamarlo due volte. Libera soltanto l'orario: non invia email all'ospite né rimborsa un pagamento, cosa che fa invece Annulla appuntamento della dashboard per un ospite che ha prenotato tramite la tua pagina.notify_calendar_guestsinvia un'email a tutti gli invitati a una prenotazione, un messaggio ciascuno, con l'invito del calendario allegato e unmessagefacoltativo fino a 2000 caratteri.kindèinviteper un nuovo appuntamento eupdateper una modifica, che è il valore predefinito. L'email parte dalla tua casella di posta in un piano che la include, e dall'indirizzo di prenotazione di Xuda altrimenti, con il tuo indirizzo come reply-to.create_booking_roomcrea la stanza Xuda Meet di una prenotazione video confermata che non ne ha, e invia a ogni ospite il link.
Che cosa chiama una pagina di prenotazione
Una pagina di prenotazione funziona con la sua chiave di pagina, <uid>.<page_id>, e senza account.
get_booking_bootstraprisponde con ciò che serve a una pagina per disegnarsi: il suo titolo, i suoi servizi e un token anti-bot recente.get_public_booking_slotselenca gli orari che un visitatore può scegliere, ciascuno con un inizio, una fine e un numero di posti. Non dice mai chi occupa gli altri posti.public_book_slotaccetta una prenotazione da un visitatore. Passapage_key,service_id,start_utc, iltoken, enameedemaildel visitatore. Aggiungi unidem_keycosì una doppia pressione non prenota due volte.company_websiteè una trappola per i bot: lascialo vuoto.- Per un servizio che si paga al momento della prenotazione,
public_start_paid_bookingblocca l'orario e avvia il pagamento,start_booking_paymentinvia a Stripe un orario bloccato, epublic_confirm_paid_bookingeconfirm_paid_bookinglo prenotano una volta che il pagamento è andato a buon fine. Il pagamento viene riletto da Stripe prima che venga prenotato qualcosa. - Un visitatore gestisce una prenotazione dal link privato nella sua email.
get_public_booking,public_cancel_bookingepublic_reschedule_bookingprendono la chiave della pagina e il valoremanagedi quel link. Seguono le regole della pagina: se i visitatori possono modificare una prenotazione e fino a quante ore prima che inizi. Una prenotazione pagata viene prima rimborsata, secondo la percentuale di rimborso della pagina.
Il piano
get_calendar_plans risponde con i quattro livelli con i loro prezzi e ciò che ciascuno include, il piano in cui sei e se Calendar è attivo. calendar_set_plan lo attiva, cambia il livello o lo disattiva: passa plan_id come calendar_free, calendar_starter, calendar_growth o calendar_business, oppure imposta deactivate su true. Vedi Piani e fatturazione.