Calendar
Dein Zeitplan, Buchungsseiten und Services.
Calendar hat öffentliche Methoden für die beiden Seiten einer Buchung. Einige handeln für dich, den Inhaber, und nehmen deinen API-Schlüssel: Sie lesen deine Einrichtung und deine Buchungen, richten Ressourcen, Leistungen und Seiten ein, reservieren und bestätigen eine Zeit, stornieren und ändern den Tarif. Andere sind die, die eine Buchungsseite für einen Besucher aufruft. Sie brauchen keinen Schlüssel, nur den Schlüssel der Seite.
Kalender mit anderen Personen teilen, die Ansichten, Aufgaben, Tagesereignisse und die Kalender-Einstellungen erledigst du im Dashboard. Sie haben heute keine öffentliche Methode.
Sende mit deinem Schlüssel eine Anfrage an eine Methode:
Eine gute Antwort hat code 1. Eine Änderung, die dein Tarif nicht enthält, wird mit code -62 und einem Satz in data abgelehnt, zum Beispiel dass Gruppensitzungen Growth brauchen oder dass dein Tarif eine bestimmte Anzahl von Buchungsseiten fasst. Um im Kalender eines Kontos zu handeln, das ihn mit dir auf der Bearbeitungsebene geteilt hat, übergib seine share_id an die Methoden, die eine nehmen.
Deine Einrichtung und Buchungen lesen
get_calendar_setupbeantwortet in einem Aufruf alles, was die Kalender-Bildschirme zeichnen: die buchbaren Personen und Räume mit ihren Zeiten, die Leistungen und die veröffentlichten Buchungsseiten mit ihren öffentlichen Adressen.get_calendar_bookingslistet Buchungen auf, standardmäßig anstehende. Übergibpastauftruefür die, die schon stattgefunden haben, die neuesten zuerst, undlimitfür die Anzahl. Jede Zeile trägt die Zeit in der Zeitzone der Ressource, die Angaben des Gasts und alles, was er bei der Buchung gesagt hat.get_calendar_slotslistet die buchbaren Zeiten einer Leistung bei einer Ressource zwischenfrom_tsundto_ts(Epoch-Millisekunden) auf, wobei alles, was schon vergeben ist, ausgelassen wird.
Einrichten, was gebucht werden kann
save_calendar_resourceerstellt oder aktualisiert etwas, das gebucht werden kann: eine Person, einen Raum, einen Stuhl oder ein Gerät. Es braucht einetimezone, eine IANA-Zone wieAsia/Jerusalem, und seine Zeiten werden in dieser Zone gelesen. Lassresource_idweg, um eine neue zu erstellen.save_calendar_serviceerstellt oder aktualisiert, was Leute buchen können: seine Dauer, Puffer, Vorlaufzeit, wie weit im Voraus gebucht werden kann, Plätze, wo es stattfindet (meeting_kind) und, mitprice_cents,currencyundcheckout, was es kostet und ob bei der Buchung bezahlt wird. Mehr als ein Platz braucht einen Tarif mit Gruppensitzungen, und Zahlungen anzunehmen braucht einen Tarif mit Zahlungen.save_calendar_pageerstellt oder aktualisiert eine Buchungsseite: ihrentitle,intro, dieservice_ids, die sie anbietet, ob sieenabledist, ihre Farbeaccent,show_host, ob Besucher ihre Buchung ändern können (visitor_changes,change_hours,refund_percent) und das Finanzkonto, auf das gezahlt wird (finance_account_id). Eine Seite über dem Seitenlimit deines Tarifs zu erstellen, wird abgelehnt.delete_calendar_itementfernt eine Ressource, eine Leistung oder eine Seite überitem_id. Buchungen werden so nie gelöscht: Sie werden storniert.
Selbst eine Zeit buchen
Das Buchen aus deinem eigenen Code besteht aus zwei Schritten, damit eine Zeit nie zweimal verkauft wird.
Die Zeit reservieren
hold_calendar_slot reserviert eine Zeit für einige Minuten. Übergib resource_id, service_id und start_utc (Epoch-Millisekunden). Eine gute Antwort hat data mit occ_id, hold_token und expires_at. Sende einen idem_key, damit eine Wiederholung des Aufrufs dieselbe Reservierung zurückgibt, statt einen zweiten Platz zu belegen.
Sie bestätigen
confirm_calendar_booking macht aus der Reservierung eine Buchung. Übergib die occ_id und das hold_token aus der Reservierung und name, email, phone und note des Gasts. Eine Reservierung, die nicht mehr da ist, hat die Zeit verloren und wird abgelehnt.
Eine Buchung ändern
cancel_calendar_bookingstorniert überbooking_idund stellt die Zeit zurück ins öffentliche Raster. Es lässt sich gefahrlos zweimal aufrufen. Es gibt nur die Zeit frei: Es sendet dem Gast keine E-Mail und erstattet keine Zahlung, was das Termin stornieren des Dashboards für einen Gast tut, der über deine Seite gebucht hat.notify_calendar_guestssendet allen, die zu einer Buchung eingeladen sind, eine E-Mail, jeweils eine Nachricht, mit angehängter Kalendereinladung und einer optionalenmessagevon bis zu 2000 Zeichen.kindistinvitefür einen neuen Termin undupdatefür eine Änderung, was der Standard ist. Die E-Mail kommt von deinem eigenen Postfach in einem Tarif, der es enthält, und sonst von der Buchungsadresse von Xuda, mit deiner Adresse als Antwortadresse.create_booking_roomerstellt den Xuda-Meet-Raum einer bestätigten Videobuchung, die keinen hat, und sendet jedem Gast den Link.
Was eine Buchungsseite aufruft
Eine Buchungsseite arbeitet mit ihrem Seitenschlüssel, <uid>.<page_id>, und ohne Konto.
get_booking_bootstrapbeantwortet, was eine Seite braucht, um sich zu zeichnen: ihren Titel, ihre Leistungen und ein frisches Anti-Bot-Token.get_public_booking_slotslistet die Zeiten auf, die ein Besucher wählen kann, jede mit einem Start, einem Ende und einer Platzzahl. Es sagt nie, wer die anderen Plätze belegt.public_book_slotnimmt eine Buchung von einem Besucher an. Übergib denpage_key,service_id,start_utc, dastokenundnameundemaildes Besuchers. Füge einenidem_keyhinzu, damit ein doppelter Druck nicht zweimal bucht.company_websiteist eine Falle für Bots: Lass es leer.- Bei einer Leistung, die bei der Buchung bezahlt wird, reserviert
public_start_paid_bookingdie Zeit und startet die Zahlung,start_booking_paymentsendet eine reservierte Zeit an Stripe, undpublic_confirm_paid_bookingundconfirm_paid_bookingbuchen sie, sobald die Zahlung durch ist. Die Zahlung wird von Stripe zurückgelesen, bevor etwas gebucht wird. - Ein Besucher verwaltet eine Buchung über den privaten Link in seiner E-Mail.
get_public_booking,public_cancel_bookingundpublic_reschedule_bookingnehmen den Seitenschlüssel und denmanage-Wert dieses Links. Sie folgen den Regeln der Seite: ob Besucher eine Buchung ändern dürfen und bis wie viele Stunden vor ihrem Beginn. Eine bezahlte Buchung wird zuerst erstattet, mit dem Erstattungsprozentsatz der Seite.
Der Tarif
get_calendar_plans beantwortet die vier Stufen mit ihren Preisen und dem, was jede trägt, welchen Tarif du hast und ob Calendar eingeschaltet ist. calendar_set_plan schaltet es ein, ändert die Stufe oder schaltet es aus: Übergib plan_id als calendar_free, calendar_starter, calendar_growth oder calendar_business, oder setze deactivate auf true. Siehe Tarife und Abrechnung.