Identificar utilizadores

Shayan TaslimAtualizado

Por predefinição, o widget trata os visitantes como anónimos. Chame uj.identify para associar o feedback, os votos, os comentários, as notificações e as 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. Utilize um ID estável da sua base de dados, em vez de um endereço de e-mail ou nome de apresentação que possa mudar. email é opcional, mas vivamente recomendado para que o UserJot possa associar o utilizador em diferentes quadros, no reencaminhamento de e-mails e nas conversas. A transmissão de um email só o associa a uma conta UserJot existente cujo endereço de e-mail tenha sido confirmado.

Quando chamar identify

Chame uj.identify assim que a sua aplicação souber quem tem sessão iniciada. Se voltar a chamá-lo com exatamente os mesmos dados enquanto a sessão ainda estiver ativa, não acontece nada. Quando a sessão expirar, ou se algum campo (incluindo o email ou os atributos) mudar, o SDK envia um novo pedido. A transmissão de um utilizador diferente muda imediatamente a sessão.

Quando o utilizador terminar sessão na sua aplicação, chame uj.logout():

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

Adicionar atributos

Os atributos são características personalizadas associadas ao perfil de um membro e apresentadas junto aos respetivos pedidos e conversas 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 cadeias de caracteres, números, valores booleanos ou null (monthlySpend, quando enviado, tem de ser um número não negativo). As chaves reservadas (como id, email, role ou companies) são ignoradas e comunicadas em result.warnings. Consulte a lista completa na referência do SDK.

Adicionar empresas

Nos produtos B2B, associe uma ou mais empresas ao utilizador:

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 Require signed tokens estiver ativada em Settings → Login, as empresas transmitidas fora de um JWT assinado são ignoradas e é apresentado um aviso UNSIGNED_COMPANY_IGNORED.

O que devolve identify

Quando o script do SDK tiver sido carregado, uj.identify devolve 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 frequência e erros

  • Limite de pedidos e espera do cliente: Os pedidos de identificação estão limitados a 30 por minuto e 300 por hora por endereço IP e espaço de trabalho. Exceder o limite horário ativa um bloqueio de 1 hora. Depois de receber HTTP 429, o SDK aplica um período de espera local (respeitando Retry-After, limitado a um intervalo entre 1 segundo e 1 hora e com um valor predefinido de 60 segundos), para que as tentativas repetidas 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 email que devolva 409 ou a um membro apagado ao abrigo do RGPD que devolva 403 / member_erased), a promessa é rejeitada com IDENTIFY_FAILED e o visitante permanece anónimo.

Identidade e conversas

Quando as Conversas estão ativadas:

  • Os utilizadores identificados não veem o pedido de dados do visitante e recebem as respostas da equipa no email associado à conta.

  • Os visitantes anónimos têm conversas de convidado associadas ao navegador, com a opção de recolher dados de contacto, conforme as definições do widget.

No widget, os visitantes anónimos podem enviar feedback e reagir a atualizações, enquanto votar positivamente no feedback, comentar e abrir o sino das Notificações requer chamar uj.identify. Para editar ou eliminar as próprias publicações e comentários no widget, é necessária uma identidade assinada.

Se a opção Exigir tokens assinados estiver ativada em Definições → Início de sessão, as chamadas identify não assinadas são rejeitadas com HTTP 403 e o visitante permanece anónimo. Utilize a Identidade assinada para verificar as contas no servidor.

Que método de autenticação devo utilizar?

Método

Onde funciona

Segurança

Plano

Guia

Não assinado (uj.identify)

Widget na aplicação

Fornecido pelo navegador (pode ser falsificado)

Todos os planos

Este artigo

Identidade assinada (JWT HS256)

Widget na aplicação (+ ligações para o portal público quando o Início de sessão automático está ativado)

JWT verificado pelo servidor

Starter & Professional (para o modo estrito)

Identidade assinada

Início de sessão automático

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

JWT HS256 verificado pelo servidor

Starter & Professional

Início de sessão automático

Início de sessão único (SSO)

Redirecionamento para o início de sessão no portal público

JWT HS256 verificado pelo servidor

Professional

Início de sessão único

SDK Swift (identify)

Aplicações iOS e macOS

Assinatura não assinada ou HMAC-SHA256

Starter & Professional (requer o Início de sessão automático)

Autenticação do SDK Swift

Passo seguinte

Verifique as identidades dos utilizadores a partir do seu backend em Identidade assinada.

Isto respondeu à sua pergunta?