L'API de Calendly connecte vos systèmes logiciels à notre plateforme de planification. Vous pouvez automatiser des tâches, synchroniser des données et améliorer la planification.
Ce guide couvre les bases pour vous aider à démarrer. Consultez le portail des développeurs et la communauté des développeurs pour obtenir de l'aide avancée.
Comment fonctionne l'API Calendly
Demande d'API
Tous les utilisateurs Calendly peuvent envoyer une demande pour obtenir des informations ou effectuer une tâche en utilisant notre API. Vous inclurez le type de données ou d'action dont vous avez besoin dans la demande.
Chaque demande est sécurisée par un jeton d'accès personnel (PAT), qui indique à l'API ce que vous êtes autorisé à faire. Nos pages de référence dans le portail expliquent comment formater votre demande et incluent tous les détails dont vous avez besoin.
Traitement de l'API
Lorsqu'une demande est envoyée, nos serveurs collectent des données, traitent des calculs ou effectuent des tâches en fonction de vos entrées. Le serveur envoie ensuite une réponse qui correspond à votre demande.
Exemple de demande :
Réponse
Une fois votre demande traitée, une réponse vous est envoyée. Elle comprendra les données que vous avez demandées ou confirmera que l'action a été effectuée. Toutes les réponses suivent des formats API standard.
Exemple de réponse :
Gestion des erreurs
Si une erreur se produit, elle est traitée avec des messages et des codes prédéfinis. Ceux-ci vous aident à résoudre des problèmes ou lorsque vous avez besoin de l'aide de l'équipe Calendly.
Exemple d'erreur :
Webhooks
Disponibles sur les plans Professionnel, Standard, Teams et Enterprise
Les webhooks fournissent des mises à jour en temps réel à vos systèmes lorsque des événements se produisent dans Calendly. Une fois configuré, Calendly vous informera instantanément si une réunion est planifiée, reprogrammée ou annulée. Cela vous permet d'automatiser des tâches ou de déclencher des actions en fonction de ces mises à jour. Pour plus de détails, consultez notre article sur les webhooks.
Accès API par plan d'abonnement
Les développeurs peuvent faire des demandes GET et POST aux interfaces de l'API au nom d'un utilisateur Calendly sur n'importe quel plan d'abonnement, y compris le plan Basic.
Cependant, certains points d'accès ne sont disponibles que pour le plan Enterprise :
- Répertorier les journaux de saisies des activités
- Supprimer les données de l'invité
- Supprimer les données d'un événement planifié
Pour les webhooks, l'utilisateur Calendly doit disposer d'un abonnement payant sur le plan Professionnel, Standard, Teams ou Enterprise. Explorez les fonctionnalités de chaque plan sur notre page de tarification.
Portées Utilisateur vs Administrateur/Propriétaire
Lors de la génération de jetons pour authentifier l'API Calendly, le niveau d'accès dépend du rôle de l'utilisateur. La portée des données disponibles varie selon que le jeton est généré par un utilisateur ou un administrateur/propriétaire :
- Rôle d'utilisateur : un jeton généré par un utilisateur permet uniquement d'accéder aux données liées à cet utilisateur spécifique. Cela comprend des webhooks qui déclenchent des événements tels que des réunions planifiées ou annulées liées à un utilisateur unique.
- Rôle d'administrateur/propriétaire : les jetons générés par un administrateur ou un propriétaire permettent un accès étendu. Ces jetons permettent aux appels API de gérer les données dans l'ensemble de l'organisation ou au sein de groupes.
Créer un jeton d'accès personnel
Vérifiez que vous générez le jeton à partir du bon compte (utilisateur ou administrateur/propriétaire) pour définir le périmètre d'accès approprié.
- Accédez à votre page Intégrations et sélectionnez API et webhooks.
- Sélectionnez Obtenir un jeton maintenant.
- Sous Définissez un nom pour ce jeton, ajoutez un nom.
- Sélectionnez Créer un jeton.
- Vous serez invité à entrer un code d'authentification. Consultez votre e-mail pour le code, puis entrez-le pour terminer la vérification.
- Une fois le jeton d'accès personnel généré, sélectionnez Copier le jeton.
Après avoir généré votre jeton d'accès personnel, consultez notre guide sur les fonctionnalités API et la création d'intégrations dans notre Guide de démarrage sur le portail développeur.
Remarque
Gardez vos jetons d'accès personnels privés et sécurisés, comme un mot de passe.
Sécurité et conformité
La sécurité de votre intégration est notre priorité absolue. Notre API adhère aux meilleures pratiques en matière de sécurité et de conformité des données, en veillant à ce que vos informations restent en sécurité. Pour plus de détails, consultez notre article Sécurité et conformité de la plateforme Calendly.
Grâce à l'API, vous pouvez gérer les utilisateurs de l'organisation en :
- Invitant des utilisateurs à rejoindre votre organisation
- Révoquant des invitations
- Supprimant des utilisateurs de votre organisation
Vous pouvez également intégrer votre application à l'aide d'OAuth 2.0 pour une autorisation sécurisée.