Casos de uso
Esta página documenta os principais casos de uso realistas onde nosso sistema irá chamar as APIs da integração.
Como estes casos de uso representam funcionalidades essenciais do sistema, as APIs devem estar disponíveis na maior parte do tempo. O volume de requisições dependerá diretamente do uso que o cliente faz da plataforma.
Dados em uma conversa
Durante uma conversa, seja por automação ou por agente de IA, o sistema pode buscar dados de qualquer entidade para determinar os próximos passos. Quando o sistema precisar apresentar opções de entidades para que o usuário faça uma escolha, ele irá consultar a API de integração para obter os dados atualizados.
Exemplo
O usuário está em uma conversa com uma automação que precisa apresentar uma lista de Serviços disponíveis para agendamento. A automação irá consultar a API para obter todos os dados de serviços associados à integração do usuário, e então apresentar essas opções na conversa para que o cliente possa escolher o serviço desejado.
Da mesma forma, se estivermos em uma conversa com um agente de IA, e o agente tiver a intenção de apresentar uma lista de serviços para que o cliente faça uma escolha, o sistema irá consultar a API para obter os dados de serviços atualizados.
Construção de mensagens
A Clinia usa um sistema de texto rico, que permite a construção de mensagens com diversos tipos de dados. Quando o sistema precisar de dados que ele não possui para construir uma mensagem, ele irá buscar os dados onde for necessário.
Isso pode ser dados que conseguimos computar com dados existentes, ou dados que precisamos buscar na API de integração.
Caso nosso sistema precise de dados de integração, ele irá buscar os dados na API.
Exemplo
O usuário está criando uma automação que apresenta os dados de um agendamento de um cliente. Nesta mensagem, ele deseja que seja exibido o nome do profissional que irá atuar no agendamento.
O dado de "Profissional" é um dado de integração, que não temos controle. Visto isso, nosso sistema irá buscar dados de um agendamento por ID, a partir do endpoint designado para esta ação.
Preenchimento de listas
Em diversas telas da interface web, como em formulários ou filtros de visualização, é necessário apresentar uma lista de entidades. Nesse momento, o sistema chama a API para obter a lista de todos os dados associados à integração do usuário para exibi-las na interface.
Não temos cache ou retenção de dados nesses componentes. Ou seja, no momento em que nossa interface web achar necessário resgatar esses dados, iremos fazer uma nova chamada à API.
Exemplo
O usuário está visualizando um formulário de agendamento. O formulário terá que apresentar todos os dados necessários para a criação do agendamento, e o usuário terá de selecionar com quais dados ele deseja criar o agendamento.
Para popular estes dados, o sistema irá chamar a API relativa a entidade sendo requerida.
Ou seja, se o formulário tiver que apresentar uma lista de Localidade, iremos chamar o endpoint designado para listar as localidades. Esses dados serão então apresentados na interface.