Calendar
Votre agenda, vos pages de réservation et vos services.
Calendrier a des méthodes publiques pour les deux côtés d'une réservation. Certaines agissent pour vous, le propriétaire, et prennent votre clé d'API : elles lisent votre configuration et vos réservations, configurent ressources, services et pages, bloquent et confirment un horaire, annulent, et changent le forfait. D'autres sont celles qu'une page de réservation appelle pour un visiteur. Elles n'ont pas besoin de clé, seulement de la clé de la page.
Le partage de calendriers avec d'autres personnes, les vues, les tâches, les événements journée et les Paramètres du Calendrier se font dans le tableau de bord. Ils n'ont aucune méthode publique aujourd'hui.
Envoyez une requête à une méthode avec votre clé :
Une bonne réponse a code 1. Un changement que votre forfait n'inclut pas est refusé avec code -62 et une phrase dans data, par exemple que les séances de groupe demandent Growth ou que votre forfait contient un certain nombre de pages de réservation. Pour agir sur le calendrier d'un compte qui l'a partagé avec vous au niveau modification, passez son share_id aux méthodes qui en prennent un.
Lire votre configuration et vos réservations
get_calendar_setuprépond en un seul appel à tout ce que dessinent les écrans de Calendrier : les personnes et les salles réservables avec leurs heures, les services, et les pages de réservation publiées avec leurs adresses publiques.get_calendar_bookingsliste les réservations, à venir par défaut. Passezpastàtruepour celles qui ont déjà eu lieu, les plus récentes en premier, etlimitpour le nombre. Chaque ligne porte l'horaire dans le fuseau de la ressource, les coordonnées de l'invité et tout ce qu'il a dit en réservant.get_calendar_slotsliste les horaires réservables d'un service sur une ressource entrefrom_tsetto_ts(millisecondes depuis l'époque), sans ce qui est déjà pris.
Configurer ce qui peut être réservé
save_calendar_resourcecrée ou met à jour quelque chose qui peut être réservé : une personne, une salle, un fauteuil ou un appareil. Il demande untimezone, un fuseau IANA commeAsia/Jerusalem, et ses heures sont lues dans ce fuseau. Omettezresource_idpour en créer une nouvelle.save_calendar_servicecrée ou met à jour ce que les gens peuvent réserver : sa durée, ses marges, son préavis, combien de temps à l'avance on peut le réserver, les places, où il a lieu (meeting_kind), et, avecprice_cents,currencyetcheckout, ce qu'il coûte et s'il est payé à la réservation. Plus d'une place demande un forfait qui inclut les séances de groupe, et l'encaissement demande un forfait qui inclut les paiements.save_calendar_pagecrée ou met à jour une page de réservation : sontitle, sonintro, lesservice_idsqu'elle propose, si elle estenabled, sa couleuraccent,show_host, si les visiteurs peuvent modifier leur réservation (visitor_changes,change_hours,refund_percent) et le compte financier sur lequel elle est payée (finance_account_id). Créer une page au-delà de la limite de pages de votre forfait est refusé.delete_calendar_itemsupprime une ressource, un service ou une page paritem_id. Les réservations ne sont jamais supprimées ainsi : elles sont annulées.
Réserver un horaire vous-même
Réserver depuis votre propre code se fait en deux étapes, pour qu'un horaire ne soit jamais vendu deux fois.
Bloquez l'horaire
hold_calendar_slot réserve un horaire pour quelques minutes. Passez resource_id, service_id et start_utc (millisecondes depuis l'époque). Une bonne réponse a un data avec occ_id, hold_token et expires_at. Envoyez une idem_key pour qu'une répétition de l'appel renvoie le même blocage au lieu de prendre une seconde place.
Confirmez-le
confirm_calendar_booking transforme le blocage en réservation. Passez l'occ_id et le hold_token du blocage, ainsi que le name, l'email, le phone et la note de l'invité. Un blocage qui n'existe plus a perdu l'horaire et est refusé.
Modifier une réservation
cancel_calendar_bookingannule parbooking_idet remet l'horaire sur la grille publique. On peut l'appeler deux fois sans risque. Il ne fait que libérer l'horaire : il n'envoie pas d'e-mail à l'invité et ne rembourse aucun paiement, ce que fait Annuler le rendez-vous du tableau de bord pour un invité qui a réservé via votre page.notify_calendar_guestsenvoie un e-mail à toutes les personnes invitées à une réservation, un message chacune, avec l'invitation de calendrier jointe et unmessagefacultatif de 2000 caractères au plus.kindvautinvitepour un nouveau rendez-vous etupdatepour une modification, ce qui est la valeur par défaut. L'e-mail part de votre propre boîte mail sur un forfait qui l'inclut, et de l'adresse de réservation de Xuda sinon, avec votre adresse en réponse.create_booking_roomcrée la salle Xuda Meet d'une réservation vidéo confirmée qui n'en a pas, et envoie le lien à chaque invité.
Ce qu'appelle une page de réservation
Une page de réservation fonctionne avec sa clé de page, <uid>.<page_id>, et sans compte.
get_booking_bootstraprépond à ce dont une page a besoin pour se dessiner : son titre, ses services et un jeton anti-robot récent.get_public_booking_slotsliste les horaires qu'un visiteur peut choisir, chacun avec un début, une fin et un nombre de places. Elle ne dit jamais qui détient les autres places.public_book_slotprend une réservation d'un visiteur. Passez lepage_key,service_id,start_utc, letoken, ainsi que lenameet l'emaildu visiteur. Ajoutez uneidem_keypour qu'un double appui ne réserve pas deux fois.company_websiteest un piège pour les robots : laissez-le vide.- Pour un service payé à la réservation,
public_start_paid_bookingbloque l'horaire et démarre le paiement,start_booking_paymentenvoie un horaire bloqué à Stripe, etpublic_confirm_paid_bookingetconfirm_paid_bookingle réservent une fois le paiement validé. Le paiement est relu auprès de Stripe avant que quoi que ce soit soit réservé. - Un visiteur gère une réservation depuis le lien privé de son e-mail.
get_public_booking,public_cancel_bookingetpublic_reschedule_bookingprennent la clé de page et la valeurmanagede ce lien. Elles suivent les règles de la page : si les visiteurs peuvent modifier une réservation, et jusqu'à combien d'heures avant son début. Une réservation payée est d'abord remboursée, selon le pourcentage de remboursement de la page.
Le forfait
get_calendar_plans répond avec les quatre niveaux, leurs prix et ce que chacun comporte, le forfait que vous avez et si Calendrier est activé. calendar_set_plan l'active, change de niveau ou le désactive : passez plan_id à calendar_free, calendar_starter, calendar_growth ou calendar_business, ou mettez deactivate à true. Voir Forfaits et facturation.