Agenda
Je planning, boekingspagina's en diensten.
Agenda heeft openbare methoden voor de twee kanten van een boeking. Sommige handelen voor jou, de eigenaar, en nemen je API-sleutel: ze lezen je instellingen en je boekingen, stellen resources, diensten en pagina's in, houden een tijd vast en bevestigen hem, annuleren en wijzigen het abonnement. Andere zijn de methoden die een boekingspagina voor een bezoeker doet. Die hebben geen sleutel nodig, alleen de sleutel van de pagina.
Agenda's met andere mensen delen, de weergaven, taken, daggebeurtenissen en Agenda-instellingen doe je in het dashboard. Daar is vandaag geen openbare methode voor.
Stuur een aanvraag met je sleutel naar een methode:
Een goed antwoord heeft code 1. Een wijziging die je abonnement niet bevat, wordt geweigerd met code -62 en een zin in data, bijvoorbeeld dat groepssessies Growth nodig hebben of dat je abonnement een aantal boekingspagina's bevat. Om te handelen op de agenda van een account dat hem met jou heeft gedeeld op bewerkingsniveau, geef je zijn share_id mee aan de methoden die er een nemen.
Lees je instellingen en boekingen
get_calendar_setupbeantwoordt in één aanroep alles wat de Agenda-schermen tekenen: de boekbare mensen en ruimtes met hun uren, de diensten en de gepubliceerde boekingspagina's met hun openbare adressen.get_calendar_bookingstoont boekingen, standaard de komende. Geefpastoptruemee voor de boekingen die al hebben plaatsgevonden, nieuwste eerst, enlimitvoor hoeveel. Elke rij bevat de tijd in de zone van de resource, de gegevens van de gast en alles wat hij bij het boeken zei.get_calendar_slotstoont de boekbare tijden van één dienst op één resource tussenfrom_tsento_ts(epoch-milliseconden), waarbij alles wat al bezet is, wordt weggelaten.
Stel in wat er geboekt kan worden
save_calendar_resourcemaakt of werkt iets bij wat geboekt kan worden: een persoon, een ruimte, een stoel of een apparaat. Het heeft eentimezonenodig, een IANA-zone zoalsAsia/Jerusalem, en de uren worden in die zone gelezen. Laatresource_idweg om een nieuwe te maken.save_calendar_servicemaakt of werkt bij wat mensen kunnen boeken: de duur, buffers, aanlooptijd, hoe ver vooruit het geboekt kan worden, plaatsen, waar het plaatsvindt (meeting_kind) en, metprice_cents,currencyencheckout, wat het kost en of het bij het boeken wordt betaald. Meer dan één plaats vraagt om een abonnement dat groepssessies bevat, en betaling innen vraagt om een abonnement dat betalingen bevat.save_calendar_pagemaakt of werkt een boekingspagina bij: zijntitle,intro, deservice_idsdie hij aanbiedt, of hijenabledis, zijnaccent-kleur, zijnbg_colorentext_color(elk#rrggbb, of leeg om de pagina ze uit het accent te laten maken),show_host, of bezoekers hun boeking kunnen wijzigen (visitor_changes,change_hours,refund_percent) en het financiële account waarop wordt uitbetaald (finance_account_id). Een pagina maken boven de paginalimiet van je abonnement wordt geweigerd.delete_calendar_itemverwijdert een resource, een dienst of een pagina opitem_id. Boekingen worden op deze manier nooit verwijderd: ze worden geannuleerd.
Zelf een tijd boeken
Boeken vanuit je eigen code gaat in twee stappen, zodat één tijd nooit twee keer wordt verkocht.
Houd de tijd vast
hold_calendar_slot reserveert een tijd voor een paar minuten. Geef resource_id, service_id en start_utc (epoch-milliseconden) mee. Een goed antwoord heeft data met occ_id, hold_token en expires_at. Stuur een idem_key mee zodat een herhaling van de aanroep dezelfde reservering teruggeeft in plaats van een tweede plaats in te nemen.
Bevestig hem
confirm_calendar_booking maakt van de reservering een boeking. Geef de occ_id en hold_token van de reservering mee, en de name, email, phone en note van de gast. Een reservering die er niet meer is, is de tijd kwijt en wordt geweigerd.
Een boeking wijzigen
cancel_calendar_bookingannuleert opbooking_iden zet de tijd terug op het openbare raster. Twee keer aanroepen is veilig. Het geeft alleen de tijd vrij: het mailt de gast niet en betaalt geen betaling terug, wat Afspraak annuleren in het dashboard wel doet voor een gast die via je pagina heeft geboekt.notify_calendar_guestsmailt iedereen die voor één boeking is uitgenodigd, elk een eigen bericht, met de agenda-uitnodiging erbij en een optioneelmessagevan maximaal 2000 tekens.kindisinvitevoor een nieuwe afspraak enupdatevoor een wijziging, wat de standaard is. De e-mail komt van je eigen mailbox op een abonnement dat dit bevat, en anders van het boekingsadres van Xuda, met jouw adres als antwoordadres.create_booking_roommaakt de Xuda Meet-ruimte van een bevestigde videoboeking die er geen heeft, en stuurt elke gast de link.
Wat een boekingspagina aanroept
Een boekingspagina werkt met zijn paginasleutel, <uid>.<page_id>, en geen account.
get_booking_bootstrapbeantwoordt wat een pagina nodig heeft om zichzelf te tekenen: zijn titel, zijn diensten en een vers antibot-token.get_public_booking_slotstoont de tijden die een bezoeker kan kiezen, elk met een begin, een einde en een aantal plaatsen. Het zegt nooit wie de andere plaatsen bezet.public_book_slotneemt een boeking aan van een bezoeker. Geef depage_key,service_id,start_utc, hettoken, en denameenemailvan de bezoeker mee. Voeg eenidem_keytoe zodat een dubbele druk niet twee keer boekt.company_websiteis een val voor bots: laat hem leeg.- Voor een dienst die bij het boeken wordt betaald, houdt
public_start_paid_bookingde tijd vast en start de betaling, stuurtstart_booking_paymenteen vastgehouden tijd naar Stripe, en boekenpublic_confirm_paid_bookingenconfirm_paid_bookinghem zodra de betaling is gedekt. De betaling wordt bij Stripe teruggelezen voordat er iets wordt geboekt. - Een bezoeker beheert een boeking via de privélink in zijn e-mail.
get_public_booking,public_cancel_bookingenpublic_reschedule_bookingnemen de paginasleutel en demanage-waarde van die link. Ze volgen de regels van de pagina: of bezoekers een boeking mogen wijzigen, en tot hoeveel uur voor het begin. Een betaalde boeking wordt eerst terugbetaald, met het terugbetalingspercentage van de pagina.
Het abonnement
get_calendar_plans beantwoordt de vier niveaus met hun prijzen en wat elk bevat, op welk abonnement je zit en of Agenda aan staat. calendar_set_plan zet het aan, wijzigt het niveau of zet het uit: geef plan_id mee als calendar_free, calendar_starter, calendar_growth of calendar_business, of zet deactivate op true. Zie Abonnementen en facturering.