Uso de la API de Microsoft Bookings en Microsoft Graph para reservas compartidas
Microsoft Bookings permite a la organización empresarial y a los propietarios de pequeñas empresas administrar las reservas de clientes y la información de las reservas compartidas con una configuración mínima. El propietario de una empresa puede crear una o más empresas, y cada una de estas puede ofrecer un conjunto de servicios. El propietario puede configurar miembros del personal y especificar los servicios que realiza cada uno. Un cliente puede reservar una cita para un servicio específico en esa empresa con una aplicación móvil o una aplicación en línea. Microsoft Bookings garantiza que la hora de la cita se mantenga actualizada para la empresa, los miembros del personal y los clientes implicados.
Importante
La API de Microsoft Bookings de Microsoft Graph solo se aplica a las reservas compartidas. La API no es aplicable a las reservas personales.
Mediante programación, en un elemento bookingBusiness de la API de Bookings se incluyen los objetos siguientes:
- Uno o más objetos bookingStaffMember
- Uno o más objetos bookingService
- Un conjunto de instancias de bookingAppointment
- Un conjunto de objetos de bookingCustomer
Uso de la API REST de Microsoft Bookings
Vea los pasos siguientes antes de reservar citas de clientes para una empresa por primera vez. Asegúrese de proporcionar los tokens de acceso correspondientes para las operaciones específicas.
- Asegúrese de que la empresa tenga una suscripción de Microsoft 365 Empresa Premium.
- Permite crear un elemento bookingBusiness mediante el envío de una operación POST al conjunto de entidades. Como mínimo, necesita especificar un nombre para la nueva empresa que verán los clientes:
POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Contoso"
}
Use la propiedad id del nuevo elemento bookingBusiness proporcionado en la respuesta POST para seguir personalizando la configuración de la empresa y agregue servicios y miembros del personal a la empresa.
- Agregue miembros del personal a la empresa:
POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/{id}/staffMembers
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Dana Swope",
"emailAddress": "danas@contoso.com",
"role": "externalGuest"
}
- Defina todos los servicios ofrecidos por la empresa:
POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/{id}/services
Authorization: Bearer {access token}
Content-Type: application/json
{
"displayName":"Bento"
}
- Publique la página de programación de la empresa para permitir que clientes y operadores empresariales empiecen a reservar citas:
POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/{id}/publish
Authorization: Bearer {access token}
En general, para mostrar una lista de todas las empresas de reservas en el espacio empresarial de Microsoft 365:
GET https://graph.microsoft.com/v1.0/solutions/bookingBusinesses
Authorization: Bearer {access token}
Casos de uso común
En la tabla siguiente, se muestran las operaciones comunes para una empresa en la API de Bookings.
Casos de uso | Recursos de REST | Vea también |
---|---|---|
Crear, obtener, actualizar o eliminar una empresa | bookingBusiness | Métodos de bookingBusiness |
Actualizar la directiva de programación | bookingSchedulingPolicy | Actualizar un elemento bookingBusiness |
Agregar, obtener, actualizar o eliminar miembros del personal | bookingStaffMember | Métodos de bookingStaffMember |
Agregar, obtener, actualizar o eliminar servicios | bookingService | Métodos de bookingService |
Agregar, obtener, actualizar o eliminar preguntas personalizadas | bookingCustomQuestion | Métodos de bookingCustomQuestion |
Agregar, obtener, actualizar o eliminar clientes | bookingCustomer | Métodos de bookingCustomer |
Publicar o cancelar la publicación de la página de programación | bookingBusiness |
publish unpublish |
Crear, obtener, actualizar, eliminar o cancelar una cita | bookingAppointment | Métodos de bookingAppointment |
Obtener las citas de un intervalo de fechas | bookingBusiness | List Bookings calendarView |
Obtener la moneda | bookingCurrency | Métodos de bookingCurrency |
Contenido relacionado
- Pruebe la API en el Probador de Graph.
- Obtenga información sobre cómo seleccionar permisos en Microsoft Graph.