Une API (en anglais Application Programming Interface, en français interface de programmation d'application) est une partie d'un programme qu'un système logiciel met à la disposition d'autres programmes pour leur connexion. Selon Wikipédia, une API est une voie standardisée par laquelle un logiciel externe peut accéder aux fonctions et aux données d'un système.
Ce qu'une API REST peut accomplir dans le système de prise de rendez-vous
- Consulter les rendez-vous disponibles : les applications externes lisent quels jours et quelles heures sont réservables.
- Créer des rendez-vous : les réservations peuvent être déclenchées par programmation depuis d'autres applications.
- Créer des utilisateurs : les comptes clients sont créés via l'API au cours de la réservation.
- Consulter les champs du formulaire : l'interface fournit elle-même les informations dont une réservation a besoin.
- Recevoir des webhooks : des événements comme de nouvelles réservations ou des annulations sont transmis en temps réel à des systèmes externes via des Webhooks.
- Intégration dans des systèmes CRM : les données clients issues des réservations peuvent être automatiquement reprises dans des systèmes de gestion de la relation client.
Caractéristiques typiques
Les API web modernes fonctionnent avec des requêtes HTTP et JSON comme format de données. Au lieu d'un mot de passe, un jeton est envoyé ; l'exploitant le génère dans l'espace d'administration et peut le renouveler à tout moment. Une limitation des requêtes par minute ainsi qu'un fonctionnement entre serveurs sont également courants : le jeton appartient sur son propre serveur et non dans un site web ou une application.
L'API d'Appointmind
Appointmind met à disposition une API REST qui reproduit le processus de réservation complet en six appels :
| Appel | Objet |
|---|---|
GET /schedules | Lister les calendriers de rendez-vous disponibles |
GET /reasons | Motifs de rendez-vous d'un calendrier avec description et durée |
GET /days | Jours où un rendez-vous est disponible |
GET /slots | Heures libres d'une journée |
GET /forms | Champs du formulaire nécessaires à la réservation |
POST /bookings | Réserver un rendez-vous |
La connexion s'effectue par jeton Bearer, généré dans l'espace d'administration sous Configuration → API ; par défaut, 300 requêtes par minute sont possibles. Vous trouverez un aperçu sur la page Module « API (interface) » et un guide pas à pas sous Configurer et utiliser l'API REST.