Идентификация пользователей

Shayan TaslimОбновлено

По умолчанию виджет считает посетителей анонимными. Вызовите uj.identify, чтобы связать отзывы, голоса, комментарии, уведомления и обсуждения с аккаунтом клиента.

Базовая идентификация

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

user.id обязателен. Используйте стабильный идентификатор из своей базы данных, а не адрес электронной почты или отображаемое имя, которые могут измениться. email необязателен, но настоятельно рекомендуется, чтобы UserJot мог сопоставлять пользователя на разных досках, при пересылке писем и в обсуждениях. Передача email связывает пользователя только с существующим аккаунтом UserJot, адрес электронной почты которого подтверждён.

Когда вызывать identify

Вызовите uj.identify, когда приложение определит, кто выполнил вход. Повторный вызов с точно такими же данными, пока сессия активна, ничего не делает. После истечения срока действия сессии или при изменении любого поля (включая адрес электронной почты и характеристики) SDK отправляет новый запрос. Передача другого пользователя немедленно переключает сессию.

Когда пользователь выходит из приложения, вызовите uj.logout():

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

Добавление атрибутов

Характеристики — это пользовательские атрибуты, прикрепленные к профилю участника и отображаемые в панели управления рядом с его запросами и переписками.

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

Значениями атрибутов могут быть строки, числа, логические значения или null (monthlySpend, если передаётся, должен быть неотрицательным числом). Зарезервированные ключи (например, id, email, role или companies) игнорируются, а сведения о них указываются в result.warnings. Полный список см. в справочнике SDK.

Добавление компаний

В B2B-продуктах можно прикрепить к пользователю одну или несколько компаний:

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 обязателен для каждой компании. name, domain, logo (URL-адрес HTTPS) и traits необязательны. Если в разделе Настройки → Вход включён параметр Требовать подписанные токены, сведения о компаниях, переданные вне подписанного JWT, игнорируются и отображается предупреждение UNSIGNED_COMPANY_IGNORED.

Что возвращает identify

После загрузки скрипта SDK uj.identify возвращает промис:

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

Ограничения частоты запросов и ошибки

  • Ограничение частоты запросов и задержка повторных запросов на стороне клиента: Количество запросов Identify ограничено: не более 30 в минуту и 300 в час с одного IP-адреса и для одного рабочего пространства. При превышении почасового лимита блокировка действует 1 час. После получения HTTP 429 SDK включает локальный период ожидания (учитывается Retry-After, значение ограничивается диапазоном от 1 секунды до 1 часа, по умолчанию — 60 секунд), чтобы повторные запросы завершались локально и не перегружали API.

  • Отклоненные вызовы: если сервер отклоняет вызов Identify (например, из-за недействительного токена, включенного параметра Require signed tokens без токена, конфликта адреса электронной почты с ответом 409 или участника, чьи данные удалены в соответствии с GDPR, с ответом 403 / member_erased), промис отклоняется с IDENTIFY_FAILED, а посетитель остается анонимным.

Идентификация и переписки

Когда включена функция «Переписки»:

  • Для идентифицированных пользователей не отображается запрос данных посетителя, а ответы команды отправляются на адрес электронной почты их учетной записи.

  • Анонимные посетители получают гостевые переписки, привязанные к браузеру. В зависимости от настроек виджета можно дополнительно запросить контактные данные.

В виджете анонимные посетители могут отправлять отзывы и реагировать на обновления, но для поддержки отзывов, комментирования и открытия колокольчика уведомлений требуется вызвать uj.identify. Чтобы редактировать или удалять собственные публикации и комментарии в виджете, требуется подписанная идентификация.

Если в разделе Settings → Login включен параметр Require signed tokens, неподписанные вызовы identify отклоняются с кодом HTTP 403, а посетитель остается анонимным. Используйте Подписанную идентификацию, чтобы проверять учетные записи на стороне сервера.

Какой способ аутентификации выбрать?

Способ

Где работает

Безопасность

Тарифный план

Руководство

Без подписи (uj.identify)

Виджет в приложении

Передается браузером (может быть подделан)

Все тарифы

Эта статья

Подписанная идентификация (JWT HS256)

Виджет в приложении (+ ссылки на общедоступный портал, если включен автоматический вход)

JWT, проверенный сервером

Starter и Professional (для строгого режима)

Подписанная идентификация

Автоматический вход

Общедоступный портал и встроенные элементы (?token=...)

HS256 JWT, проверенный сервером

Starter и Professional

Автоматический вход

Единый вход (SSO)

Перенаправление для входа на общедоступный портал

HS256 JWT, проверенный сервером

Professional

Единый вход

SDK Swift (identify)

Приложения для iOS и macOS

Без подписи или с подписью HMAC-SHA256

Starter и Professional (требуется автоматический вход)

Аутентификация с помощью SDK Swift

Следующий шаг

Проверяйте идентификаторы пользователей на стороне сервера с помощью подписанной идентификации.

Эта статья ответила на ваш вопрос?