Kalender
Timeplanen din, bookingsider og tjenester.
Calendar har offentlige metoder for de to sidene av en booking. Noen handler for deg, eieren, og tar API-nøkkelen din: de leser oppsettet og bookingene dine, setter opp ressurser, tjenester og sider, holder og bekrefter et tidspunkt, avbestiller og endrer planen. Andre er de en bookingside gjør for en besøkende. De trenger ingen nøkkel, bare sidens nøkkel.
Deling av kalendere med andre, visningene, oppgavene, dagshendelsene og Kalenderinnstillinger gjøres i dashbordet. De har ingen offentlig metode i dag.
Send en forespørsel til en metode med nøkkelen din:
Et godt svar har code 1. En endring planen din ikke inkluderer, avvises med code -62 og en setning i data, for eksempel at gruppetimer krever Growth eller at planen din rommer et visst antall bookingsider. For å handle på kalenderen til en konto som delte den med deg på redigeringsnivå, sender du share_id til metodene som tar en.
Les oppsettet og bookingene dine
get_calendar_setupsvarer med alt Kalender-skjermbildene tegner i ett kall: personene og rommene som kan bookes, med åpningstidene sine, tjenestene og de publiserte bookingsidene med sine offentlige adresser.get_calendar_bookingslister bookinger, kommende som standard. Sendpastsatt tiltruefor de som allerede har skjedd, nyeste først, oglimitfor hvor mange. Hver rad har tidspunktet i ressursens sone, gjestens opplysninger og alt de sa da de booket.get_calendar_slotslister de bookbare tidspunktene for én tjeneste på én ressurs mellomfrom_tsogto_ts(epoch-millisekunder), uten alt som allerede er tatt.
Sett opp hva som kan bookes
save_calendar_resourcelager eller oppdaterer noe som kan bookes: en person, et rom, en stol eller en enhet. Den trenger entimezone, en IANA-sone somAsia/Jerusalem, og åpningstidene leses i den sonen. Utelatresource_idfor å lage en ny.save_calendar_servicelager eller oppdaterer det folk kan booke: lengden, buffere, varsel, hvor langt fram den kan bookes, plasser, hvor den møtes (meeting_kind), og, medprice_cents,currencyogcheckout, hva den koster og om den betales ved booking. Mer enn én plass krever en plan som inkluderer gruppetimer, og å ta betaling krever en plan som inkluderer betalinger.save_calendar_pagelager eller oppdaterer en bookingside:title,intro,service_idsden tilbyr, om den erenabled, aksentfargenaccent,bg_colorogtext_color(hver#rrggbb, eller tom for at siden lager den fra aksenten),show_host, om besøkende kan endre bookingen sin (visitor_changes,change_hours,refund_percent) og finanskontoen den betales inn på (finance_account_id). Å lage en side over planens sidegrense avvises.delete_calendar_itemfjerner en ressurs, en tjeneste eller en side meditem_id. Bookinger slettes aldri på denne måten: de avbestilles.
Book et tidspunkt selv
Å booke fra din egen kode er to steg, så ett tidspunkt aldri selges to ganger.
Hold tidspunktet
hold_calendar_slot reserverer et tidspunkt i noen 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 gjentakelse av kallet returnerer samme hold i stedet for å ta en ny plass.
Bekreft det
confirm_calendar_booking gjør holdet om til en booking. Send occ_id og hold_token fra holdet, og gjestens name, email, phone og note. Et hold som ikke finnes lenger, har mistet tidspunktet og avvises.
Endre en booking
cancel_calendar_bookingavbestiller medbooking_idog legger tiden tilbake på det offentlige rutenettet. Det er trygt å kalle to ganger. Den frigir bare tiden: den sender ikke e-post til gjesten og refunderer ingen betaling, noe Avbestill avtalen i dashbordet gjør for en gjest som booket gjennom siden din.notify_calendar_guestssender e-post til alle som er invitert til én booking, én melding hver, med kalenderinvitasjonen vedlagt og en valgfrimessagepå opptil 2000 tegn.kinderinvitefor en ny avtale ogupdatefor en endring, som er standard. E-posten kommer fra din egen postboks på en plan som inkluderer det, og ellers fra Xudas bookingadresse, med adressen din som svaradresse.create_booking_roomlager Xuda Meet-rommet til en bekreftet videobooking som ikke har noe, og sender hver gjest lenken.
Hva en bookingside kaller
En bookingside virker med sidenøkkelen sin, <uid>.<page_id>, og ingen konto.
get_booking_bootstrapsvarer med det en side trenger for å tegne seg selv: tittelen, tjenestene og et ferskt anti-bot-token.get_public_booking_slotslister tidspunktene en besøkende kan velge, hvert med en start, en slutt og et antall plasser. Den sier aldri hvem som har de andre plassene.public_book_slottar imot en booking fra en besøkende. Sendpage_key,service_id,start_utc,tokenog den besøkendesnameogemail. Legg til enidem_keyså et dobbelt trykk ikke booker to ganger.company_websiteer en felle for roboter: la den stå tom.- For en tjeneste som betales ved booking holder
public_start_paid_bookingtidspunktet og starter betalingen,start_booking_paymentsender et holdt tidspunkt til Stripe, ogpublic_confirm_paid_bookingogconfirm_paid_bookingbooker det når betalingen er gjennomført. Betalingen leses tilbake fra Stripe før noe bookes. - En besøkende styrer en booking fra den private lenken i e-posten sin.
get_public_booking,public_cancel_bookingogpublic_reschedule_bookingtar sidenøkkelen og lenkensmanage-verdi. De følger sidens regler: om besøkende kan endre en booking, og opptil hvor mange timer før den starter. En betalt booking refunderes først, med sidens refusjonsprosent.
Planen
get_calendar_plans svarer med de fire nivåene med priser og hva hvert har, hvilken plan du er på og om Calendar er slått på. calendar_set_plan slår det på, endrer nivået eller slår det av: send plan_id som calendar_free, calendar_starter, calendar_growth eller calendar_business, eller sett deactivate til true. Se Planer og fakturering.