Kalender
Ditt schema, bokningssidor och tjänster.
Calendar har publika metoder för bokningens två sidor. Några agerar för dig, ägaren, och tar din API-nyckel: de läser din uppsättning och dina bokningar, ställer in resurser, tjänster och sidor, reserverar och bekräftar en tid, avbokar och ändrar planen. Andra är de som en bokningssida gör för en besökare. De behöver ingen nyckel, bara sidans nyckel.
Att dela kalendrar med andra, vyerna, uppgifter, daghändelser och Kalenderinställningar görs i dashboarden. De har ingen publik metod i dag.
Skicka en begäran till en metod med din nyckel:
Ett bra svar har code 1. En ändring som din plan inte inkluderar nekas med code -62 och en mening i data, till exempel att gruppsessioner kräver Growth eller att din plan rymmer ett visst antal bokningssidor. För att agera på kalendern för ett konto som delat den med dig på redigeringsnivå skickar du dess share_id till metoderna som tar en.
Läs din uppsättning och dina bokningar
get_calendar_setupsvarar med allt som Calendar-skärmarna ritar i ett enda anrop: personerna och rummen som kan bokas med sina tider, tjänsterna och de publicerade bokningssidorna med sina publika adresser.get_calendar_bookingslistar bokningar, kommande som standard. Angepastsatt tilltrueför de som redan har ägt rum, nyaste först, ochlimitför hur många. Varje rad bär tiden i resursens zon, gästens uppgifter och allt de sa när de bokade.get_calendar_slotslistar de bokningsbara tiderna för en tjänst på en resurs mellanfrom_tsochto_ts(epok-millisekunder), med allt som redan är taget utelämnat.
Ställ in vad som kan bokas
save_calendar_resourceskapar eller uppdaterar något som kan bokas: en person, ett rum, en stol eller en enhet. Den kräver entimezone, en IANA-zon somAsia/Jerusalem, och dess tider läses i den zonen. Utelämnaresource_idför att skapa en ny.save_calendar_serviceskapar eller uppdaterar vad folk kan bokas: dess längd, buffertar, framförhållning, hur långt framåt den kan bokas, platser, var den möts (meeting_kind) och, medprice_cents,currencyochcheckout, vad den kostar och om den betalas vid bokning. Mer än en plats kräver en plan som inkluderar gruppsessioner, och att ta betalt kräver en plan som inkluderar betalningar.save_calendar_pageskapar eller uppdaterar en bokningssida: desstitle,intro, deservice_idsden erbjuder, om den ärenabled, dessaccent-färg, dessbg_colorochtext_color(var och en#rrggbb, eller tom för att låta sidan göra den utifrån accenten),show_host, om besökare kan ändra sin bokning (visitor_changes,change_hours,refund_percent) och finanskontot den betalas in på (finance_account_id). Att skapa en sida över din plans sidgräns nekas.delete_calendar_itemtar bort en resurs, en tjänst eller en sida meditem_id. Bokningar tas aldrig bort på det här sättet: de avbokas.
Boka en tid själv
Att boka från din egen kod är två steg, så att en tid aldrig säljs två gånger.
Reservera tiden
hold_calendar_slot reserverar en tid i några minuter. Ange resource_id, service_id och start_utc (epok-millisekunder). Ett bra svar har data med occ_id, hold_token och expires_at. Skicka en idem_key så att en upprepning av anropet ger samma reservation i stället för att ta en andra plats.
Bekräfta den
confirm_calendar_booking gör reservationen till en bokning. Ange occ_id och hold_token från reservationen, och gästens name, email, phone och note. En reservation som inte finns kvar har tappat tiden och nekas.
Ändra en bokning
cancel_calendar_bookingavbokar medbooking_idoch lägger tillbaka tiden i det publika rutnätet. Det är säkert att anropa två gånger. Den frigör bara tiden: den mejlar inte gästen och återbetalar ingen betalning, vilket dashboardens Avboka mötet gör för en gäst som bokade genom din sida.notify_calendar_guestsmejlar alla som är inbjudna till en bokning, ett meddelande var, med kalenderinbjudan bifogad och ett valfrittmessagepå upp till 2000 tecken.kindärinviteför ett nytt möte ochupdateför en ändring, vilket är standard. Mejlet kommer från din egen brevlåda på en plan som inkluderar det, och annars från Xudas bokningsadress, med din adress som svarsadress.create_booking_roomskapar Xuda Meet-rummet för en bekräftad videobokning som saknar ett, och skickar länken till varje gäst.
Vad en bokningssida anropar
En bokningssida fungerar med sin sidnyckel, <uid>.<page_id>, och inget konto.
get_booking_bootstrapsvarar med det en sida behöver för att rita sig själv: dess titel, dess tjänster och en färsk anti-bot-token.get_public_booking_slotslistar tiderna som en besökare kan välja, var och en med en start, ett slut och ett antal platser. Den säger aldrig vem som har de andra platserna.public_book_slottar emot en bokning från en besökare. Angepage_key,service_id,start_utc,tokenoch besökarensnameochemail. Lägg till enidem_keyså att ett dubbeltryck inte bokar två gånger.company_websiteär en fälla för botar: lämna det tomt.- För en tjänst som betalas vid bokning reserverar
public_start_paid_bookingtiden och startar betalningen,start_booking_paymentskickar en reserverad tid till Stripe, ochpublic_confirm_paid_bookingochconfirm_paid_bookingbokar den när betalningen har gått igenom. Betalningen läses tillbaka från Stripe innan något bokas. - En besökare hanterar en bokning från den privata länken i sitt mejl.
get_public_booking,public_cancel_bookingochpublic_reschedule_bookingtar sidnyckeln och den länkensmanage-värde. De följer sidans regler: om besökare får ändra en bokning och upp till hur många timmar före start. En betald bokning återbetalas först, med sidens återbetalningsprocent.
Planen
get_calendar_plans svarar med de fyra nivåerna med sina priser och vad var och en bär, vilken plan du har och om Calendar är påslaget. calendar_set_plan slår på det, byter nivå eller slår av det: ange plan_id som calendar_free, calendar_starter, calendar_growth eller calendar_business, eller sätt deactivate till true. Se Planer och fakturering.