Documentação

Tudo o que você precisa para colocar o Ontara no seu site e responder aos visitantes em qualquer idioma.

Instalar o widget

Entre, crie um espaço de trabalho e abra Widget de chat no painel. Copie o seu código e cole antes de </body> em todas as páginas:

<script src="https://YOUR-LINGLY-HOST/w.js" data-site="pk_your_site_key" async></script>

O widget só funciona no domínio que você cadastrou e nos subdomínios dele (por exemplo, example.com também cobre shop.example.com). Antes de instalar, abra a Página de teste no painel para experimentar.

WordPress

Instale o plugin do Ontara para WordPress, ou cole o mesmo código com qualquer plugin de scripts de cabeçalho e rodapé.

Aplicações de página única

Adicione o script uma vez no seu template HTML. Ele continua funcionando quando as rotas mudam no cliente.

API JavaScript

Depois que o script carrega, um pequeno objeto global fica disponível:

ChamadaO que faz
lingly.open()Abre a janela do chat, por exemplo a partir do seu próprio botão “Fale conosco”.
lingly.close()Fecha a janela do chat.
lingly.identify({ userId, email, name, hash })Informa ao Ontara quem é o visitante. Veja a verificação de identidade.
lingly.reset()Esquece o visitante, por exemplo quando um usuário sai da conta.
lingly.shutdown()Remove o widget da página.

Tradução

Defina o idioma da equipe em Equipe. Quando um visitante escreve em outro idioma, a mensagem é traduzida para a sua equipe e o original fica a um clique. Suas respostas são traduzidas para o idioma do visitante antes de serem entregues. A mensagem de boas-vindas e as respostas automáticas também são traduzidas.

Ative ou desative a tradução em Automação. Os botões do próprio widget seguem o idioma do navegador do visitante (inglês, chinês, espanhol, português, francês, alemão, japonês, coreano e italiano), ou um idioma que você escolher.

Respostas da IA

  1. Adicione conteúdo em Base de conhecimento: perguntas e respostas, o endereço de uma página ou texto.
  2. Use Teste a IA na mesma página para ver como ela responderia.
  3. Em Automação, escolha quando a IA responde: só quando não há ninguém online, ou sempre primeiro.

A IA responde só com base na sua base de conhecimento e no idioma do visitante. Quando não sabe responder, ou o visitante pede para falar com uma pessoa, ela passa a conversa para a sua equipe e para de responder naquela conversa. Ela também para assim que alguém da equipe responde.

Quando você não está

Equipe e funções

FunçãoPode
ProprietárioTudo, inclusive a cobrança.
AdministradorConfigurações, base de conhecimento, sites, convites e cobrança.
AtendenteResponder conversas e ler a base de conhecimento.

Convide pessoas em Equipe. Elas entram fazendo login com o e-mail convidado. Todos os planos têm atendentes ilimitados.

Planos e limites

Veja os preços para saber o que cada plano inclui. Quando um limite mensal é atingido, o chat ao vivo continua funcionando; as respostas da IA e a tradução ficam pausadas até o mês seguinte ou até você fazer upgrade. Conversas mais antigas que o período de histórico do seu plano são excluídas automaticamente.

Verificação de identidade

Quando um visitante está logado no seu site, você pode informar ao Ontara quem ele é e provar isso, para que ninguém consiga se passar por um dos seus usuários.

  1. Em Widget de chat → Verificação de identidade, ative-a e copie o segredo. Guarde-o só no seu servidor.
  2. No servidor, calcule hex(HMAC-SHA256(secret, userId)).
  3. Na página, chame lingly.identify({ userId, email, name, hash }).
// Node.js import { createHmac } from "node:crypto"; const hash = createHmac("sha256", process.env.LINGLY_IDENTITY_SECRET).update(user.id).digest("hex"); // PHP $hash = hash_hmac('sha256', $userId, getenv('LINGLY_IDENTITY_SECRET'));

Os atendentes veem um selo de Verificado ao lado do visitante. Uma chamada com hash errado é rejeitada. Visitantes que só digitam o e-mail no chat não aparecem como verificados.

Respostas por e-mail

Quando sua resposta chega por e-mail a um visitante que já saiu, basta ele responder a esse e-mail. A resposta aparece na mesma conversa, sem o texto citado e as assinaturas.

Para isso é preciso um domínio de recebimento. No Cloudflare Email Routing, encaminhe r-*@reply.your-domain.com para o Worker do Ontara e defina INBOUND_EMAIL_DOMAIN=reply.your-domain.com. Só o endereço do próprio visitante pode escrever na conversa dele; respostas automáticas e devoluções são ignoradas.

Notificações

Em Conta → Notificações do navegador, cada membro da equipe pode ativar as notificações no dispositivo que está usando. Quando um visitante escreve e a caixa de entrada não está aberta, aparece uma notificação; um clique abre a conversa. Os alertas por e-mail (em Equipe) continuam funcionando como reserva.

React

Instale @lingly/react, coloque <LinglyChat siteKey="pk_..." user={...} /> no componente raiz e use useLingly() para obter open, close, identify e reset. Quando o usuário sai da conta (user vira null), o widget esquece o visitante. O pacote ainda não foi publicado no npm; até lá, a API JavaScript faz o mesmo em qualquer app React.

WordPress

  1. Baixe o plugin e, no WordPress, vá em Plugins → Adicionar novo → Enviar plugin.
  2. Ative-o e abra Configurações → Ontara Chat.
  3. Cole a chave do site. Se quiser, cole também o segredo da verificação de identidade para que usuários logados no WordPress apareçam como verificados.

API REST

Crie uma chave em Desenvolvedores e envie-a em cada requisição com Authorization: Bearer lk_.... Há endpoints para listar seus sites, listar e consultar conversas, ler mensagens, responder como sua equipe (a resposta é traduzida para o visitante), fechar e reabrir, excluir conversas e ver os detalhes de um visitante. Cada chave permite 120 requisições por minuto. A referência completa está na versão em inglês.

Webhooks

Adicione um endpoint https em Desenvolvedores e escolha os eventos que quiser. Cada evento chega como um POST em JSON com o cabeçalho Lingly-Signature: t=timestamp,v1=assinatura, em que a assinatura é hex(HMAC-SHA256(secret, t + "." + rawBody)). Responda com qualquer status 2xx. Entregas que falham são repetidas por cerca de 20 minutos, e um endpoint que continua falhando é pausado. Um evento pode chegar duas vezes de vez em quando, então use id para ignorar duplicatas.