Compartilhar via

Usar a API Microsoft Bookings no Microsoft Graph para reservas compartilhadas

  • Artigo

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

O Microsoft Bookings permite que proprietários de pequenas empresas gerenciem reservas e informações de clientes com configuração mínima. Um proprietário de empresa pode criar um ou mais negócios e cada empresa oferece um conjunto de serviços. O proprietário pode definir membros da equipe e especificar os serviços que cada membro da equipe executará. Um cliente pode agendar um horário para um serviço específico nesse negócio em um aplicativo online ou móvel. O Bookings garante que o horário do compromisso seja mantido atualizado para a empresa, funcionários e clientes envolvidos.

Importante

A API Microsoft Bookings no Microsoft Graph se aplica apenas a reservas compartilhadas. A API não é aplicável a reservas pessoais.

Programaticamente, um bookingBusiness na API do Bookings envolve os seguintes objetos:

Como usar a API REST do Bookings

Siga as etapas a seguir antes de agendar os compromissos do cliente para uma empresa pela primeira vez. Certifique-se de fornecer os tokens de acesso apropriados para as operações correspondentes.

  1. Certifique-se que a empresa tenha um assinatura do Microsoft 365 Business Premium.
  2. Crie um novo bookingBusiness enviando uma operação POST para o conjunto de entidades. No mínimo, você deve especificar um nome para a nova empresa que os clientes verão:
POST https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Contoso"
}

Use a propriedade id do novo bookingBusiness retornado na resposta do POST para continuar a personalizar configurações de negócios e adicionar funcionários e serviços para a empresa.

  1. Adicione membros individuais da equipe para a empresa:
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"
}
  1. Defina cada serviço oferecido pela empresa:
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/services
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Bento"
}
  1. Publique a página de agendamento para a empresa, para permitir que clientes e operadores de negócios comecem a agendar compromissos:
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/publish
Authorization: Bearer {access token}

Em geral, para listar todas as empresas de agendamento no locatário do Microsoft 365:

GET https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}

Casos de uso comuns

A tabela a seguir lista as operações comuns para uma empresa na API do Bookings.

Casos de uso Recursos REST Confira também
Criar, acessar, atualizar ou excluir uma empresa bookingBusiness Métodos de bookingBusiness
Atualizar a política de agendamento bookingSchedulingPolicy Atualizar um bookingBusiness
Adicionar, obter, atualizar ou excluir membros da equipe bookingStaffMember Métodos de bookingStaffMember
Adicionar, obter, atualizar ou excluir serviços bookingService Métodos de bookingService
Publicar ou cancelar a publicação da página de agendamento bookingBusiness publish
unpublish
Criar, obter, atualizar, excluir ou cancelar um compromisso bookingAppointment Métodos de bookingAppointment
Obter compromissos em um intervalo de datas bookingBusiness Listar o calendarView do Bookings
Obter moeda bookingCurrency Métodos de bookingCurrency

Conteúdo relacionado