Integração WhatsApp para agendamento

Essa API tem como objetivo automatizar a criação de agendamento via WhatsApp.

Abaixo, você encontrará respostas para suas perguntas em relação à comunicação com está API:

• Disclaimer
• Primeiros passos
• Autenticação
• Como funciona o fluxo de agendamento
• Outras operações disponíveis

Disclaimer

Uma nova versão deste API já está em desenvolvimento. Sendo assim, esta versão (v1) da API será descontinuada em 2025

Primeiros passos

Para iniciar o uso desta API será necessário obter duas informações junto a BEMP: SEU_DOMINIO e SEU_TOKEN.

Para obter o seu token de acesso e seu domínio, você deve solicitar os mesmo para o setor de suporte diretamente dentro da plataforma (menu AJUDA).

Autenticação

A autenticação é feita através da utilização do TOKEN (solicitado no passo anterior), esse token único que irá identificar sua conta na BEMP.

De posse do TOKEN, basta adicionar em todas as chamadas HTTP o header:

Authorization: Token SEU_TOKEN

Como funciona o fluxo de agendamento

Para criar um agendamento, é necessário seguir os passos abaixo onde são coletados os dados necessários e por fim criado o agendamento:

1. Escolha da unidade (obrigatório)
   • Fazendo um GET no endereço abaixo você obtém todas as unidades
     

     https://SEU_DOMINIO.bemp.app/api/salons

2. Escolha do serviço (obrigatório)
   • Fazendo um GET no endereço abaixo você obtém os serviços disponíveis para unidade selecionada anteriormente (ID_DA_UNIDADE)

     https://SEU_DOMINIO.bemp.app/api/salons/#ID_DA_UNIDADE#/services

3. Escolha um profissional (opcional)
   • Fazendo um GET no endereço abaixo você obtém os profissionais disponíveis para unidade (ID_DA_UNIDADE) e o serviço (ID_DO_SERVICO) selecionados anteriormente

     https://SEU_DOMINIO.bemp.app/api/salons/ID_DA_UNIDADE/services/ID_DO_SERVICO/professionals

4. Escolha o horário (obrigatório)
   • Fazendo um GET no endereço abaixo você obtém todos os horários disponíveis para unidade (ID_DA_UNIDADE), serviço (ID_DO_SERVICO)  e o profissional (ID_DO_PROFISSIONAL) selecionados anteriormente:
     • Quando utilizada a etapa 3 (escolha de um profissional)

       https://SEU_DOMINIO.bemp.app/api/salons/ID_DA_UNIDADE/services/ID_DO_SERVICO/professionals/ID_DO_PROFISSIONAL/slots/DATA

     • Quando NÃO utilizada a etapa 3 (escolha de um profissional)

       https://SEU_DOMINIO.bemp.app/api/salons/ID_DA_UNIDADE/services/ID_DO_SERVICO/slots/DATA

   • Data precisa estar no formato YYYY-MM_DD
5. Criação do agendamento
   • Fazendo um POST para o endereço baixo  

     https://webhooks.bemp.app/webhooks/whatsapp_schedule

   • É preciso enviar no corpo da requisição todos os dados coletados nas etapas anteriores juntamente com nome e telefone do cliente (código do país, DDD e número):

     {
       "salon_id": 7,
       "service_id": 14,
       "professional_id": 22, // opcional
       "start": "2023-09-12T13:30:00.000-03:00",
       "end": "2023-09-12T14:00:00.000-03:00",
       "name": "Fulano da Silva",
       "phone_country_code": "55",
       "phone_area_code": "51",
       "phone_number": "99999999"
     }

Outras operações disponíveis

• Consulta Cliente
  • Fazendo um GET no endereço abaixo e informando o telefone do cliente (código do país, DDD e número) você obtém todos os dados de um cliente:

    https://webhooks.bemp.app/webhooks/whatsapp_customer?phone_country_code=CODIDO_DO_PAI&phone_area_code=DDD&phone_number=NUMERO

• Consulta Agendamentos
  • Fazendo um GET no endereço abaixo e informando o telefone do cliente (código do país, DDD e número) você obtém todos os agendamentos abertos de um cliente:

    https://webhooks.bemp.app/webhooks/whatsapp_schedule?phone_country_code=CODIDO_DO_PAI&phone_area_code=DDD&phone_number=NUMERO

• Cancelar agendamento
  • Fazendo um DELETE no endereço abaixo e informar o telefone do cliente (código do país, DDD e número) e o ID do agendamento que você deseja cancelar, o agendamento é cancelado:
    

    https://webhooks.bemp.app/webhooks/whatsapp_schedule?phone_country_code=CODIDO_DO_PAI&phone_area_code=DDD&phone_number=NUMERO&id=ID_AGENDAMENTO