Graces

APIs de Integração – Pacote Agenda

A evolução dos negócios exige sistemas cada vez mais conectados. Pensando nisso, disponibilizamos uma nova solução desenvolvida para integrar nossa plataforma aos sistemas que fazem parte do dia a dia da sua empresa.

Com as APIs de integração, você poderá automatizar processos, eliminar atividades manuais, reduzir retrabalho e proporcionar uma experiência mais ágil para clientes e colaboradores. Seja por meio de aplicativos, portais, CRMs, plataformas de atendimento, chatbots ou sistemas próprios, as integrações permitem que as informações circulem de forma segura e em tempo real.

Pacote Inicial: Integração com Agenda

Nesta primeira fase, disponibilizamos um conjunto de APIs voltado para a operação da Agenda, permitindo que sistemas externos consultem informações e realizem operações diretamente em nossa plataforma.

Consultas disponíveis

Permitem obter informações necessárias para execução das ações da Agenda:

  • Consulta configuração da loja para cadastramento de clientes (dados obrigatórios)

  • Consulta configuração da franquia para agendamento automático e configuração da loja para horários de funcionamento da unidade

  • Pesquisa de clientes por número de celular;
  • Pesquisa de serviços ativos por Descrição Agenda/App;

  • Pesquisa de profissionais ativos na loja vinculados ao serviço;
  • Consulta dos próximos agendamentos do cliente;
  • Consulta do histórico de serviços, retornos e sessões executados pelo cliente;
  • Consulta de pacotes com seções pendentes por cliente;
  • Consulta da agenda completa, restrita a 7 dias antes e 7 dias depois da data atual – horários ocupados;
  • Consulta da agenda por profissional – horário ocupados;
  • Consulta da agenda do profissional – horário livres.

Importante!
A consulta de horário livres do profissional utiliza a configuração definida na Franquia em Configurações > Opções do Sistema > Agenda > Intervalo padrão da agenda.
Então, para melhor aproveitamento, defina o menor intervalo possível.


Operações disponíveis

Permitem executar ações diretamente na Agenda:

  • Cadastramento de clientes;
  • Inclusão de agendamentos por serviço ou seção de pacote;
  • Alteração de agendamentos;
  • Cancelamento de agendamentos;
  • Atualização do status de confirmação dos agendamentos.


Geração de tokens

Após a contratação do módulo, poderão ser gerados até 10 tokens de acesso.
Para isso, o usuário deverá ter a seguinte permissão habilitada: Configuração > Sistema > Menu Integrações. Então, basta acessar Loja > Configurações > Opções de Sistema > Integrações e gerar a quantidade necessária de tokens para o módulo Agenda, definindo uma descrição para o seu controle.

Os tokens gerados poderão ser excluídos a qualquer momento, conforme sua necessidade.

Geração de webhooks

Poderão ser gerados até 10 webhooks para recebimento dos eventos da agenda, que contemplam inclusão, alteração e exclusão de agendamentos e bloqueios.
Os eventos de alteração serão disparados quando houver mudanças nos seguintes campos: data, hora início, hora fim, profissional, serviço, status e configurações de recorrências.

Na criação do webhook será sugerido um token de autenticação, que poderá ser substituído por um código próprio. Faça o teste de comunicação e monitore o log de notificação, que apresentará a situação da última comunicação real realizada.

Os webhooks gerados poderão ser alterados ou excluídos a qualquer momento, conforme sua necessidade.

Dica!
Ao cadastrar o webhook, faça o teste de comunicação, mas não esqueça de salvar os dados.

Documentação para integração

A documentação técnica para desenvolvimento da integração está disponível no site Graces, na seção Área do Desenvolvedor, localizada no rodapé da página.

Ficou alguma dúvida?
Entre em contato com a gente!