Calendar
Programul tău, pagini de rezervare și servicii.
Calendar are metode publice pentru cele două părți ale unei rezervări. Unele acționează pentru tine, proprietarul, și iau cheia ta API: îți citesc configurarea și rezervările, configurează resurse, servicii și pagini, rețin și confirmă o oră, anulează și schimbă planul. Altele sunt cele pe care le face o pagină de rezervare pentru un vizitator. Nu au nevoie de cheie, doar de cheia paginii.
Partajarea calendarelor cu alți oameni, vizualizările, sarcinile, evenimentele de zi și Setările Calendar se fac în dashboard. Nu au nicio metodă publică în prezent.
Trimite o cerere către o metodă cu cheia ta:
Un răspuns bun are code 1. O schimbare pe care planul tău nu o include este refuzată cu code -62 și o propoziție în data, de exemplu că sesiunile de grup au nevoie de Growth sau că planul tău include un anumit număr de pagini de rezervare. Ca să acționezi pe calendarul unui cont care l-a partajat cu tine la nivel de editare, dă share_id metodelor care îl primesc.
Citește configurarea și rezervările
get_calendar_setuprăspunde într-un singur apel cu tot ce desenează ecranele Calendar: persoanele și camerele care pot fi rezervate, cu orele lor, serviciile și paginile de rezervare publicate, cu adresele lor publice.get_calendar_bookingslistează rezervările, implicit pe cele viitoare. Dăpastsetat petruepentru cele care au avut deja loc, cele mai noi primele, șilimitpentru câte. Fiecare rând poartă ora în fusul resursei, datele invitatului și orice a spus la rezervare.get_calendar_slotslistează orele rezervabile ale unui serviciu pe o resursă întrefrom_tsșito_ts(milisecunde epoch), cu tot ce este deja ocupat lăsat deoparte.
Configurează ce se poate rezerva
save_calendar_resourcecreează sau actualizează ceva ce poate fi rezervat: o persoană, o cameră, un scaun sau un dispozitiv. Are nevoie de untimezone, un fus IANA precumAsia/Jerusalem, iar orele lui se citesc în acel fus. Omiteresource_idpentru a crea una nouă.save_calendar_servicecreează sau actualizează ce pot rezerva oamenii: durata, pauzele, preavizul, cât de devreme poate fi rezervat, locurile, unde are loc (meeting_kind) și, cuprice_cents,currencyșicheckout, cât costă și dacă se plătește la rezervare. Mai mult de un loc are nevoie de un plan care include sesiuni de grup, iar încasarea plății are nevoie de un plan care include plăți.save_calendar_pagecreează sau actualizează o pagină de rezervare:title,intro,service_idspe care le oferă, dacă esteenabled, culoareaaccent,bg_colorșitext_color(fiecare#rrggbb, sau gol ca pagina să le deducă din accent),show_host, dacă vizitatorii își pot schimba rezervarea (visitor_changes,change_hours,refund_percent) și contul financiar în care se plătește (finance_account_id). Crearea unei pagini peste limita de pagini a planului tău este refuzată.delete_calendar_itemelimină o resursă, un serviciu sau o pagină dupăitem_id. Rezervările nu se șterg niciodată astfel: se anulează.
Rezervă tu o oră
Rezervarea din propriul cod se face în doi pași, ca o oră să nu fie vândută de două ori.
Reține ora
hold_calendar_slot rezervă o oră pentru câteva minute. Dă resource_id, service_id și start_utc (milisecunde epoch). Un răspuns bun are data cu occ_id, hold_token și expires_at. Trimite un idem_key ca o repetare a apelului să returneze aceeași reținere în loc să ia un al doilea loc.
Confirmă-o
confirm_calendar_booking transformă reținerea într-o rezervare. Dă occ_id și hold_token din reținere, precum și name, email, phone și note ale invitatului. O reținere care nu mai există a pierdut ora și este refuzată.
Schimbă o rezervare
cancel_calendar_bookinganulează dupăbooking_idși pune ora înapoi pe grila publică. Poate fi apelată de două ori în siguranță. Doar eliberează ora: nu trimite e-mail invitatului și nu rambursează o plată, ceea ce face Anulează programarea din dashboard pentru un invitat care a rezervat prin pagina ta.notify_calendar_gueststrimite e-mail tuturor celor invitați la o rezervare, un mesaj fiecăruia, cu invitația de calendar atașată și unmessageopțional de până la 2000 de caractere.kindesteinvitepentru o programare nouă șiupdatepentru o schimbare, care este valoarea implicită. E-mailul vine din propria ta căsuță pe un plan care o include și din adresa de rezervări a Xuda în caz contrar, cu adresa ta ca reply-to.create_booking_roomcreează camera Xuda Meet a unei rezervări video confirmate care nu are una și trimite fiecărui invitat linkul.
Ce apelează o pagină de rezervare
O pagină de rezervare funcționează cu cheia ei de pagină, <uid>.<page_id>, și fără cont.
get_booking_bootstraprăspunde cu ce are nevoie o pagină ca să se deseneze: titlul, serviciile și un token anti-bot proaspăt.get_public_booking_slotslistează orele pe care le poate alege un vizitator, fiecare cu un început, un sfârșit și un număr de locuri. Nu spune niciodată cine ocupă celelalte locuri.public_book_slotprimește o rezervare de la un vizitator. Dăpage_key,service_id,start_utc,token, precum șinameșiemailale vizitatorului. Adaugă unidem_keyca o dublă apăsare să nu rezerve de două ori.company_websiteeste o capcană pentru roboți: lasă-l gol.- Pentru un serviciu care se plătește la rezervare,
public_start_paid_bookingreține ora și începe plata,start_booking_paymenttrimite o oră reținută la Stripe, iarpublic_confirm_paid_bookingșiconfirm_paid_bookingo rezervă după ce plata s-a încheiat. Plata este citită înapoi din Stripe înainte să se rezerve ceva. - Un vizitator își gestionează rezervarea din linkul privat din e-mailul lui.
get_public_booking,public_cancel_bookingșipublic_reschedule_bookingprimesc cheia paginii și valoareamanagea acelui link. Urmează regulile paginii: dacă vizitatorii pot schimba o rezervare și cu cel mult câte ore înainte de începerea ei. O rezervare plătită se rambursează mai întâi, cu procentul de rambursare al paginii.
Planul
get_calendar_plans răspunde cu cele patru niveluri, cu prețurile și ce poartă fiecare, în ce plan ești și dacă Calendar este pornit. calendar_set_plan îl pornește, schimbă nivelul sau îl oprește: dă plan_id ca calendar_free, calendar_starter, calendar_growth sau calendar_business, sau setează deactivate pe true. Vezi Planuri și facturare.