Übersicht zur Calendly-API

Calendlys API verbindet Ihre Softwaresysteme mit unserer Terminplanungsplattform. Sie können Aufgaben automatisieren, Daten synchronisieren und die Terminplanung verbessern.

Dieser Leitfaden behandelt die Grundlagen für Ihre ersten Schritte. Check out the Developer Portal and the Developer Community for advanced help.

Wie die Calendly-API funktioniert

API-Anforderung

Alle Calendly-Benutzer können über unsere API eine Anfrage senden, um Informationen zu erhalten oder eine Aufgabe zu erledigen. In der Anfrage geben Sie an, welche Art von Daten oder Aktionen Sie benötigen.

Jede Anfrage ist mit einem persönlichen Zugriffstoken (PAT) gesichert, der der API mitteilt, was Sie tun dürfen. Unsere Referenzseiten im Portal erläutern, wie Sie Ihre Anfrage formatieren können, und enthalten alle Details, die Sie benötigen.

API-Verarbeitung

Wenn eine Anfrage gesendet wird, erfassen unsere Server Daten, verarbeiten Berechnungen oder führen Aufgaben basierend auf Ihren Eingaben aus. Der Server sendet dann eine Antwort, die Ihrer Anfrage entspricht.

Beispiel für eine Anfrage:

Antwort

Sobald Ihre Anfrage bearbeitet wurde, erhalten Sie eine Antwort. Es enthält entweder die von Ihnen angeforderten Daten oder bestätigt, dass die Aktion abgeschlossen wurde. Alle Antworten folgen den API-Standardformaten.

Antwortbeispiel:

Fehlerbehandlung

Wenn ein Fehler auftritt, wird dieser mit voreingestellten Meldungen und Codes behandelt. Diese helfen bei der Fehlerbehebung oder wenn Sie Unterstützung vom Calendly-Team benötigen.

Fehlerbeispiel:

Webhooks

Webhooks bieten Echtzeit-Aktualisierungen für Ihre Systeme, wenn Ereignisse in Calendly auftreten. Sobald Sie die Einrichtung abgeschlossen haben, benachrichtigt Calendly Sie sofort, wenn ein Meeting geplant, verschoben oder abgesagt wird. Auf diese Weise können Sie Aufgaben automatisieren oder Aktionen auf Grundlage dieser Updates auslösen. Weitere Informationen finden Sie in unserem Artikel zu Webhooks.

API-Zugriff je nach Abonnement

Entwickler können GET- und POST-Anfragen im Namen eines Calendly-Benutzers mit jedem Abonnementplan, einschließlich des Basis-Abos, an API-Endpunkte senden.

Bestimmte Endpunkte sind jedoch nur für das Enterprise-Abo verfügbar:

• Aktivitätsprotokolle auflisten
• Daten zu eingeladenen Personen löschen
• Geplante Ereignisdaten löschen

Für Webhooks muss der Calendly-Benutzer ein kostenpflichtiges Abonnement für den Professional-, Standard-, Teams- oder Enterprise-Plan haben. Informieren Sie sich auf unserer Preisseite über die Funktionen der einzelnen Tarife.

Berechtigungsbereiche für Benutzer vs. Admin/Eigentümer

Beim Generieren von Token zur Authentifizierung der Calendly-API hängt die Zugriffsebene von der Rolle des Benutzers ab. Der Umfang verfügbarer Daten hängt davon ab, ob das Token von einem Benutzer oder einem Admin/Eigentümer generiert wird:

• Benutzerrolle: Ein von einem Benutzer generiertes Token ermöglicht nur den Zugriff auf Daten, die mit diesem bestimmten Benutzer verknüpft sind. Dazu gehören Webhooks, die Ereignisse wie geplante oder abgesagte Meetings auslösen, die sich auf den individuellen Benutzer beziehen.
• Rolle des Admins oder Eigentümers: Von einem Admin oder Eigentümer generierte Token bieten breiteren Zugriff. Mit diesen Tokens können API-Aufrufe Daten in der gesamten Organisation oder innerhalb von Gruppen verwalten.

Erstellen Sie einen persönlichen Zugriffstoken.

Vergewissern Sie sich, dass Sie das Token aus dem richtigen Konto (Benutzer oder Admin oder Eigentümer) erstellen, um den entsprechenden Zugriffsumfang festzulegen.

1. Besuchen Sie Ihre Integrationsseite und wählen Sie API und Webhooks aus.
2. Wählen Sie Token jetzt abrufen.
3. Fügen Sie unter Einen Namen für das Token festlegen einen Namen hinzu.
4. Wählen Sie Token erstellen.
5. Sie werden aufgefordert, einen Authentifizierungscode einzugeben. Überprüfen Sie Ihre E-Mail auf den Code, und geben Sie ihn dann ein, um die Bestätigung abzuschließen.
6. Sobald das persönliche Zugriffstoken erzeugt wurde, wählen Sie Token kopieren auswählen.

Nachdem Sie Ihren persönlichen Zugriffstoken generiert haben, lesen Sie unseren Leitfaden zu API-Funktionen und dem Erstellen von Integrationen in unserem Handbuch für Erste Schritte im Entwicklerportal.

Sicherheit und Compliance

Die Sicherheit Ihrer Integration hat für uns oberste Priorität. Unsere API entspricht den Best Practices für Sicherheit und Datenkonformität und stellt sicher, dass Ihre Informationen sicher bleiben. Weitere Informationen finden Sie in unserem Artikel Calendly Plattform-Sicherheit und -Compliance.

Über die API können Sie Organisationsbenutzer verwalten, indem Sie:

• Benutzer einladen, Ihrer Organisation beizutreten
• Einladungen widerrufen
• Benutzer aus Ihrer Organisation entfernen

Sie können Ihre App auch mit OAuth 2.0 für eine sichere Authentifizierung integrieren.