Este caso de uso descreve etapas de exemplo de configuração e uso de API que são necessárias para integrar a funcionalidade Co-Navegação/LiveView em outro sistema.

Etapas

1. Configuração

Na configuração do plugin do backend, ative o plugin LiveView. Usamos a seguinte configuração em nosso exemplo.

Configuração Valor Descrição

Privacidade

Mask user inputs

Queremos mascarar todas as entradas do usuário que acontecem em nossa página.

Optar por

Visitor

Queremos que o usuário clique no botão que inicia o CoBrowsing.

2. Implementação de Script

O JavaScript precisa ser integrado em cada página da Web onde desejamos fazer a co-navegação.

Aprenda como implementar o LiveView em sua página.

3. Iniciar e parar a sessão CoNavegação/LiveView

Vamos iniciar ou parar a sessão LiveView com essas funções CV.cobrowse.start() e CV.cobrowse.stop(). Portanto, implementamos simplesmente um botão no qual o usuário possa clicar e iniciar a sessão.

Se você não quiser um botão para a aceitação, pode simplesmente desativar a configuração da opção na etapa 1.

Quanto tempo dura uma sessão? Ir para a página

4. Gere um URL de participação para o agente

Depois que a sessão for iniciada com sucesso, podemos agora gerar uma URL pública com a qual o agente pode entrar na sessão. Para isso, precisamos da shareId ou da sessionId para ingressar, gerar a URL com a REST API.

Autentique e gere um token de API. Acesse a documentação

Depois disso, podemos simplesmente enviar uma solicitação GET para o endpoint da API, descrito no link a seguir. Antes disso, temos que transferir a shareId ou a sessionId to o servidor para identificar a sessão, e depois podemos gerar a URL que pode ser aberta sem autenticação.

API REST para gerar um URL público de participação

Este é um URL exclusivo assinado com um token e sempre vinculado à sessão com a ID fornecida.