Identificar usuários

Shayan TaslimAtualizado

Por padrão, o widget trata os visitantes como anônimos. Chame uj.identify para associar feedback, votos, comentários, notificações e conversas à conta de um cliente.

Identificação básica

JavaScript
uj.identify({
  user: {
    id: 'user-123',
    email: 'ada@example.com',
    firstName: 'Ada',
    lastName: 'Lovelace',
    avatar: 'https://example.com/avatar.jpg'
  }
});

user.id é obrigatório. Use um ID estável do seu banco de dados, em vez de um endereço de e-mail ou nome de exibição que possa mudar. email é opcional, mas altamente recomendado para que o UserJot possa reconciliar o usuário entre quadros, encaminhamento de e-mails e conversas. O envio de um email só associa o usuário a uma conta existente do UserJot cujo endereço de e-mail tenha sido confirmado.

Quando chamar identify

Chame uj.identify quando seu app souber quem está conectado. Chamá-lo novamente com exatamente a mesma carga útil enquanto a sessão ainda estiver ativa não faz nada. Quando a sessão expirar, ou se qualquer campo (incluindo e-mail ou atributos) mudar, o SDK enviará uma nova solicitação. Passar um usuário diferente troca a sessão imediatamente.

Quando o usuário sair do seu app, chame uj.logout():

JavaScript
if (user) {
  uj.identify({
    user: {
      id: user.id,
      email: user.email,
      firstName: user.firstName,
      lastName: user.lastName
    }
  });
} else {
  uj.logout();
}

Adição de atributos

Atributos são características personalizadas associadas ao perfil de um membro e exibidas ao lado das solicitações e conversas dele no painel.

JavaScript
uj.identify({
  user: {
    id: 'user-123',
    email: 'ada@example.com',
    traits: {
      plan: 'pro',
      seats: 12,
      trialing: false
    }
  }
});

Os valores dos atributos podem ser strings, números, valores booleanos ou null (monthlySpend, quando enviado, deve ser um número não negativo). Chaves reservadas (como id, email, role ou companies) são ignoradas e informadas em result.warnings. Consulte a lista completa na referência do SDK.

Adição de empresas

Para produtos B2B, associe uma ou mais empresas ao usuário:

JavaScript
uj.identify({
  user: { id: 'user-123', email: 'ada@example.com' },
  companies: [
    {
      id: 'acme',
      name: 'ACME Inc.',
      domain: 'acme.com',
      logo: 'https://acme.com/logo.png',
      traits: { plan: 'enterprise', arr: 24000 }
    }
  ]
});

id é obrigatório para cada empresa. name, domain, logo (URL HTTPS) e traits são opcionais. Se a opção Exigir tokens assinados estiver ativada em Configurações → Login, as empresas enviadas fora de um JWT assinado serão ignoradas, e um aviso UNSIGNED_COMPANY_IGNORED será exibido.

O que identify retorna

Depois que o script do SDK for carregado, uj.identify retornará uma promessa:

JavaScript
const result = await uj.identify({
  user: { id: 'user-123', email: 'ada@example.com' }
});

result.viewer;        // the identified user, or null
result.identityTrust; // 'signed' or 'unsigned'
result.warnings;      // fields the server ignored or adjusted

Limites de solicitações e erros

  • Limite de solicitações e espera do cliente: as solicitações de identificação têm limite de 30 por minuto e 300 por hora por endereço IP e espaço de trabalho. Exceder o limite por hora aciona um bloqueio de 1 hora. Após receber o HTTP 429, o SDK aplica um período de espera local (respeitando Retry-After, limitado entre 1 segundo e 1 hora e com padrão de 60 segundos), para que os ciclos de novas tentativas falhem localmente sem sobrecarregar a API.

  • Chamadas rejeitadas: se o servidor rejeitar uma chamada de identificação (por exemplo, devido a um token inválido, à opção Exigir tokens assinados ativada sem um token, a um conflito de e-mail que retorne 409 ou a um membro apagado em conformidade com o GDPR que retorne 403 / member_erased), a promessa será rejeitada com IDENTIFY_FAILED e o visitante continuará anônimo.

Identidade e conversas

Quando Conversas está ativado:

  • Os usuários identificados não veem a solicitação de dados do visitante e recebem as respostas da equipe no e-mail associado à conta.

  • Visitantes anônimos têm conversas de convidados vinculadas ao navegador, com a opção de coletar dados de contato conforme as configurações do widget.

No widget, visitantes anônimos podem enviar feedback e reagir às atualizações, enquanto votar positivamente no feedback, comentar e abrir o sino de Notificações exigem uma chamada a uj.identify. Para editar ou excluir as próprias publicações e comentários no widget, é necessário usar Identidade assinada.

Se a opção Exigir tokens assinados estiver ativada em Configurações → Login, as chamadas identify sem assinatura serão rejeitadas com HTTP 403 e o visitante continuará anônimo. Use Identidade assinada para verificar contas no servidor.

Qual método de autenticação devo usar?

Método

Onde funciona

Segurança

Plano

Guia

Sem assinatura (uj.identify)

Widget no app

Fornecido pelo navegador (pode ser falsificado)

Todos os planos

Este artigo

Identidade assinada (JWT HS256)

Widget no app (+ links para o portal público quando o Login automático está ativado)

JWT verificado pelo servidor

Starter e Professional (para o modo estrito)

Identidade assinada

Login automático

Portal público e incorporações em linha (?token=...)

JWT HS256 verificado pelo servidor

Starter e Professional

Login automático

Logon único (SSO)

Redirecionamento para o login do portal público

JWT HS256 verificado pelo servidor

Professional

Logon único

SDK do Swift (identify)

Apps para iOS e macOS

Sem assinatura ou assinatura HMAC-SHA256

Starter e Professional (requer Login automático)

Autenticação do SDK do Swift

Próxima etapa

Verifique as identidades dos usuários no seu back-end com Identidade assinada.

Isso respondeu à sua pergunta?