Ідентифікація користувачів
За замовчуванням віджет вважає відвідувачів анонімними. Викличте uj.identify, щоб прив’язати відгуки, голоси, коментарі, сповіщення та розмови до облікового запису клієнта.
Базова ідентифікація
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():
if (user) {
uj.identify({
user: {
id: user.id,
email: user.email,
firstName: user.firstName,
lastName: user.lastName
}
});
} else {
uj.logout();
}Додавання атрибутів
Атрибути — це власні характеристики, прикріплені до профілю учасника. Вони відображаються поруч із його запитами та розмовами на панелі керування.
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-продуктів прив’яжіть до користувача одну чи кілька компаній:
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 повертає проміс:
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
429SDK застосовує локальний період очікування (враховуєRetry-After, обмежує значення діапазоном від 1 секунди до 1 години та за замовчуванням встановлює 60 секунд), щоб повторні спроби завершувалися локально, не надсилаючи надмірну кількість запитів до API.Відхилені виклики: якщо сервер відхиляє виклик Identify (наприклад, через недійсний токен, увімкнений параметр Require signed tokens без токена, конфлікт адреси електронної пошти, що повертає
409, або учасника, дані якого стерто відповідно до GDPR, що повертає403/member_erased), проміс відхиляється зIDENTIFY_FAILED, а відвідувач залишається анонімним.
Ідентичність і розмови
Коли ввімкнено Conversations:
Ідентифіковані користувачі пропускають запит на введення контактних даних і отримують відповіді команди на адресу електронної пошти свого облікового запису.
Анонімні відвідувачі отримують гостьові розмови, прив’язані до браузера, а за потреби — можливість надати контактні дані відповідно до налаштувань віджета.
У віджеті анонімні відвідувачі можуть надсилати відгуки та реагувати на оновлення, а для голосування за відгуки, коментування та відкриття дзвіночка сповіщень потрібно викликати uj.identify. Щоб редагувати або видаляти власні дописи й коментарі у віджеті, потрібна підписана ідентичність.
Якщо в розділі Settings → Login увімкнено параметр Require signed tokens, непідписані виклики identify відхиляються з HTTP 403, а відвідувач залишається анонімним. Щоб перевіряти облікові записи на стороні сервера, використовуйте Signed identity.
Який спосіб автентифікації використовувати?
Спосіб | Де працює | Безпека | Тарифний план | Посібник |
|---|---|---|---|---|
Без підпису ( | Віджет у застосунку | Передається браузером (можна підробити) | Усі тарифні плани | Ця стаття |
Підписана ідентифікація (HS256 JWT) | Віджет у застосунку (+ посилання на публічний портал, якщо ввімкнено автоматичний вхід) | JWT, перевірений сервером | Starter і Professional (для суворого режиму) | |
Автоматичний вхід | Публічний портал і вбудовані елементи ( | HS256 JWT, перевірений сервером | Starter і Professional | |
Єдиний вхід (SSO) | Переспрямування для входу на публічний портал | HS256 JWT, перевірений сервером | Professional | |
Swift SDK ( | Застосунки для iOS і macOS | Без підпису або з підписом HMAC-SHA256 | Starter і Professional (потрібен автоматичний вхід) |
Наступний крок
Перевіряйте ідентичність користувачів із вашого серверного застосунку за допомогою підписаної ідентифікації.