Utiliser l’API Microsoft Bookings dans Microsoft Graph pour les réservations partagées
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Microsoft Bookings permet aux responsables d’entreprise et aux petites entreprises de gérer les livres clients et les informations avec une configuration minimale. Un dirigeant d’entreprise peut créer une ou plusieurs entreprises qui offrent chacune leurs propres services. Le dirigeant peut configurer les employés et indiquer les services que chaque employé assure. Un client peut prendre un rendez-vous pour un service proposé par cette entreprise dans une application mobile ou en ligne. Bookings permet à l’entreprise, aux employés et aux clients concernés de consulter l’heure du rendez-vous.
Importante
L’API Microsoft Bookings dans Microsoft Graph s’applique uniquement aux réservations partagées. L’API ne s’applique pas aux réservations personnelles.
Côté programme, un objet bookingBusiness dans l’API Bookings implique :
- un ou plusieurs objets bookingStaffMember ;
- un ou plusieurs objets bookingService ;
- un jeu d’instances bookingAppointment ;
- un jeu d’objets bookingCustomer.
Utilisation de l’API REST Bookings
Suivez la procédure suivante avant de proposer aux clients de prendre rendez-vous. Assurez-vous que vous fournissez les jetons d’accès correspondant aux opérations.
- Vérifiez que l’entreprise a un abonnement Microsoft 365 Business Premium.
- Créez un objet bookingBusiness en envoyant une opération POST au jeu d’entités. Vous devez au moins spécifier un nom pour la nouvelle entreprise, que les clients verront :
POST https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Contoso"
}
Utilisez la propriété id du nouvel objet bookingBusiness renvoyé dans la réponse POST pour continuer à personnaliser les paramètres de l’entreprise, puis ajoutez les employés et les services de l’entreprise.
- Ajoutez les employés pour l’entreprise :
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/staffMembers
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Dana Swope",
"emailAddress": "danas@contoso.com",
"role": "externalGuest"
}
- Définissez les services proposés par l’entreprise :
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/services
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Bento"
}
- Publiez la page de planification pour l’entreprise afin de permettre aux clients et aux exploitants de commencer à prendre rendez-vous :
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/publish
Authorization: Bearer {access token}
En général, pour répertorier toutes les entreprises de réservation dans le client Microsoft 365 :
GET https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}
Cas d’utilisation courants
Le tableau suivant répertorie les opérations courantes réalisées par les entreprises dans l’API Bookings.
Cas d’utilisation | Ressources REST | Voir aussi |
---|---|---|
Créer, obtenir, mettre à jour ou supprimer une entreprise | bookingBusiness | Méthodes de l’objet bookingBusiness |
Mettre à jour la stratégie de planification | bookingSchedulingPolicy | Mise à jour d’un objet bookingBusiness |
Ajouter, obtenir, mettre à jour ou supprimer des employés | bookingStaffMember | Méthodes de l’objet bookingStaffMember |
Ajouter, obtenir, mettre à jour ou supprimer des services | bookingService | Méthodes de l’objet bookingService |
Publier ou annuler la publication de la page de planification | bookingBusiness |
Publication Annuler la publication |
Créer, obtenir, mettre à jour, supprimer ou annuler un rendez-vous | bookingAppointment | Méthodes de l’objet bookingAppointment |
Obtenir les rendez-vous compris dans une plage de dates | bookingBusiness | Liste des objets calendarView dans Bookings |
Obtenir la devise | bookingCurrency | Méthodes de l’objet bookingCurrency |
Contenu connexe
- Essayez l’API dans l’Afficheur Graph.
- Découvrez comment choisir des autorisations dans Microsoft Graph.