Kalender
Din kalender, bookingsider og tjenester.
Calendar har offentlige metoder til bookingens to sider. Nogle handler for dig, ejeren, og tager din API-nøgle: de læser din opsætning og dine bookinger, sætter ressourcer, tjenester og sider op, reserverer og bekræfter et tidspunkt, aflyser og skifter plan. Andre er dem, en bookingside foretager for en besøgende. De kræver ingen nøgle, kun sidens nøgle.
Deling af kalendere med andre, visningerne, opgaver, dagsbegivenheder og Kalenderindstillinger sker i dashboardet. De har ingen offentlig metode i dag.
Send en anmodning til en metode med din nøgle:
Et godt svar har code 1. En ændring, din plan ikke indeholder, afvises med code -62 og en sætning i data, for eksempel at gruppesessioner kræver Growth, eller at din plan rummer et bestemt antal bookingsider. For at handle på kalenderen hos en konto, der delte den med dig på redigeringsniveau, sender du dens share_id til de metoder, der tager en.
Læs din opsætning og dine bookinger
get_calendar_setupsvarer med alt, hvad Calendar-skærmbillederne tegner, i ét kald: de personer og rum, der kan bookes, med deres åbningstider, tjenesterne og de udgivne bookingsider med deres offentlige adresser.get_calendar_bookingslister bookinger, som standard de kommende. Sendpastsat tiltruefor dem, der allerede er sket, nyeste først, oglimitfor hvor mange. Hver række har tidspunktet i ressourcens zone, gæstens oplysninger og alt, vedkommende sagde ved bookingen.get_calendar_slotslister de tidspunkter, en tjeneste kan bookes på hos én ressource mellemfrom_tsogto_ts(epoch-millisekunder), med alt, der allerede er taget, udeladt.
Sæt op, hvad der kan bookes
save_calendar_resourcelaver eller opdaterer noget, der kan bookes: en person, et rum, en stol eller en enhed. Den kræver entimezone, en IANA-zone somAsia/Jerusalem, og dens åbningstider læses i den zone. Udeladresource_idfor at lave en ny.save_calendar_servicelaver eller opdaterer det, folk kan booke: længde, buffere, varsel, hvor langt frem det kan bookes, pladser, hvor det foregår (meeting_kind), og medprice_cents,currencyogcheckouthvad det koster, og om det betales ved booking. Mere end én plads kræver en plan med gruppesessioner, og at tage betaling kræver en plan med betalinger.save_calendar_pagelaver eller opdaterer en bookingside: denstitle,intro, deservice_ids, den tilbyder, om den erenabled, densaccent-farve, densbg_colorogtext_color(hver#rrggbb, eller tom, så siden laver den ud fra accenten),show_host, om besøgende kan ændre deres booking (visitor_changes,change_hours,refund_percent) og den finanskonto, der betales ind på (finance_account_id). At lave en side ud over din plans sidegrænse afvises.delete_calendar_itemfjerner en ressource, en tjeneste eller en side viaitem_id. Bookinger slettes aldrig på denne måde: de aflyses.
Book et tidspunkt selv
At booke fra din egen kode er to trin, så ét tidspunkt aldrig sælges to gange.
Reserver tidspunktet
hold_calendar_slot reserverer et tidspunkt i nogle få minutter. Send resource_id, service_id og start_utc (epoch-millisekunder). Et godt svar har data med occ_id, hold_token og expires_at. Send en idem_key, så en gentagelse af kaldet returnerer den samme reservation i stedet for at tage en ekstra plads.
Bekræft det
confirm_calendar_booking gør reservationen til en booking. Send occ_id og hold_token fra reservationen og gæstens name, email, phone og note. En reservation, der ikke findes mere, har mistet tidspunktet og afvises.
Ret en booking
cancel_calendar_bookingaflyser viabooking_idog lægger tidspunktet tilbage på det offentlige gitter. Den er sikker at kalde to gange. Den frigiver kun tidspunktet: den sender ikke e-mail til gæsten og refunderer ikke en betaling, hvilket dashboardets Aflys aftale gør for en gæst, der bookede gennem din side.notify_calendar_guestssender e-mail til alle, der er inviteret til én booking, én besked hver, med kalenderinvitationen vedhæftet og en valgfrimessagepå op til 2000 tegn.kinderinvitefor en ny aftale ogupdatefor en ændring, som er standard. E-mailen kommer fra din egen postkasse på en plan, der indeholder den, og ellers fra Xudas bookingadresse med din adresse som svaradresse.create_booking_roomlaver Xuda Meet-rummet til en bekræftet videobooking, der ikke har et, og sender hver gæst linket.
Hvad en bookingside kalder
En bookingside arbejder med sin sidenøgle, <uid>.<page_id>, og ingen konto.
get_booking_bootstrapsvarer med det, en side skal bruge for at tegne sig selv: dens titel, dens tjenester og et frisk anti-bot-token.get_public_booking_slotslister de tidspunkter, en besøgende kan vælge, hver med en start, en slut og et antal pladser. Den siger aldrig, hvem der har de andre pladser.public_book_slottager imod en booking fra en besøgende. Sendpage_key,service_id,start_utc,tokenog den besøgendesnameogemail. Tilføj enidem_key, så et dobbelt tryk ikke booker to gange.company_websiteer en fælde for bots: lad den stå tom.- For en tjeneste, der betales ved booking, reserverer
public_start_paid_bookingtidspunktet og starter betalingen,start_booking_paymentsender et reserveret tidspunkt til Stripe, ogpublic_confirm_paid_bookingogconfirm_paid_bookingbooker det, når betalingen er gået igennem. Betalingen læses tilbage fra Stripe, før noget bookes. - En besøgende styrer en booking fra det private link i sin e-mail.
get_public_booking,public_cancel_bookingogpublic_reschedule_bookingtager sidenøglen og det linksmanage-værdi. De følger sidens regler: om besøgende må ændre en booking, og op til hvor mange timer før den starter. En betalt booking refunderes først, med sidens refusionsprocent.
Planen
get_calendar_plans svarer med de fire niveauer med deres priser og hvad hvert rummer, hvilken plan du er på, og om Calendar er slået til. calendar_set_plan slår det til, skifter niveau eller slår det fra: send plan_id som calendar_free, calendar_starter, calendar_growth eller calendar_business, eller sæt deactivate til true. Se Planer og fakturering.