Como enviar informações adicionais de usuários usando o SDK da Akece
O SDK da Akece permite que você envie informações adicionais sobre os usuários que acessam seu site, diretamente para a
plataforma. Essas informações ajudam sua equipe a oferecer um atendimento mais personalizado.
Inicializando o SDK
Após instalar o widget da Akece no seu site, o objeto window.$akece ficará disponível. Para garantir que ele tenha sido
carregado corretamente, escute o evento akece:ready:
window.addEventListener("akece:ready", function () {
// Use window.$akece aqui
});
Você também pode escutar mensagens recebidas usando:
window.addEventListener("akece:on-message", function(e) {
console.log('akece:on-message', e.detail);
});
Configurações do widget
Você pode personalizar o comportamento do widget com window.chatwootSettings:
window.akeceSettings = {
hideMessageBubble: false,
showUnreadMessagesDialog: false,
position: "right",
locale: "pt_BR",
useBrowserLanguage: false,
type: "standard",
darkMode: "auto",
showPopoutButton: true,
launcherTitle: "Fale com a gente"
};
Design do widget
- standard: Ícone tradicional do chat
- expanded_bubble: Balão de texto expandido com título personalizável
Idioma automático
Para usar o idioma do navegador do visitante:
useBrowserLanguage: true
Nesse caso, o valor de locale será ignorado.
Abrir ou ocultar o widget via código
window.$akece.toggleBubbleVisibility("show");
window.$akece.toggleBubbleVisibility("hide");
window.$akece.toggle(); // Alterna entre abrir/fechar
window.$akece.toggle("open"); // Abre
window.$akece.toggle("close"); // Fecha
Para abrir em janela pop-up:
window.$chatwoot.popoutChatWindow();
Como identificar um usuário
Use setUser para associar dados do visitante ao widget:
window.$akece.setUser("ID_UNICO_DO_USUARIO", {
email: "[email protected]",
name: "Nome do Usuário",
avatar_url: "https://url-da-imagem.com",
phone_number: "+551199999999"
});
Validação com HMAC
Para garantir a segurança e evitar falsificação de identidade, recomenda-se ativar a validação via HMAC:
window.$akece.setUser("ID_UNICO_DO_USUARIO", {
name: "Nome",
email: "[email protected]",
identifier_hash: "HASH_GERADO",
phone_number: "+55...",
avatar_url: "https://...",
description: "Perfil do usuário",
country_code: "BR",
city: "São Paulo",
company_name: "Empresa",
social_profiles: {
linkedin: "usuario"
}
});
Saiba mais sobre como gerar o hash HMAC na documentação técnica.
Atributos personalizados
Você pode enviar dados adicionais com setCustomAttributes:
window.$akece.setCustomAttributes({
plano: "premium",
dataCadastro: "2024-01-01"
});
Para remover um atributo personalizado:
window.$akece.deleteCustomAttribute("plano");
Definir rótulos na conversa
Se o visitante ainda não iniciou uma conversa, é possível pré-definir rótulos:
window.$akece.setLabel("pedido-suporte");
window.$akece.removeLabel("pedido-suporte");
Alterar idioma manualmente
window.$akece.setLocale("pt_BR");
Redefinir sessão (logout)
window.$akece.reset();
Monitorar erros do widget
window.addEventListener("akece:error", function () {
// Lógica de tratamento
});
Se precisar de ajuda para integrar o SDK ou enviar dados personalizados ao widget, fale com a gente:
📩 [email protected] | 📱 @akece.ai