身份验证

Shayan Taslim更新

使用 UserJot.identify(...) 将已登录的应用用户传递给 UserJot,让反馈和投票与其帐户关联。

Note

前提条件:在 设置 → 登录中启用自动登录(Starter 和 Professional 套餐可用)。即使不启用要求签名令牌,Swift SDK 也会通过自动登录交换用户身份。

基本身份识别

至少传递一个来自您自己的数据库的稳定用户 ID(而不是会话令牌或可能变更的电子邮件地址):

Swift
UserJot.identify(userId: "user_123")

尽可能提供电子邮件地址和个人资料字段,以便帐户在 UserJot 的各个界面中正确匹配:

Swift
UserJot.identify(
    userId: "user_123",
    email: "john@example.com",
    firstName: "John",
    lastName: "Doe",
    avatar: "https://example.com/avatar.jpg"
)
Warning

请勿使用属于 任何 UserJot 工作区所有者或管理员的电子邮件地址测试客户端身份识别。这些账号无法通过客户端自动登录,必须直接通过 UserJot 登录。

何时识别用户以及何时退出登录

  • 应用恢复或创建经过身份验证的会话后,以及个人资料字段发生变更时,请调用 UserJot.identify(...)。

  • 每当用户退出您的应用时,请调用 UserJot.logout(),以免设备上的下一位用户继承该会话。

Swift
@MainActor
func handleLogin(user: User) {
    UserJot.identify(
        userId: user.id,
        email: user.email,
        firstName: user.firstName,
        lastName: user.lastName
    )
}

@MainActor
func handleLogout() {
    UserJot.logout()
}

签名身份验证(HMAC-SHA256)

如需通过服务器验证身份,请使用您的 项目密钥(位于 设置 → 登录 → 密钥)对用户的 userId 计算 HMAC-SHA256 十六进制摘要,并将其作为 signature 传递:

Swift
UserJot.identify(
    userId: "user_123",
    email: "john@example.com",
    signature: signatureFromYourServer
)

如需对每次调用都强制使用签名,请在 设置 → 登录中启用要求签名令牌(启用自动登录后会显示此选项)。切勿将项目密钥嵌入 iOS 或 macOS 应用程序包中;请始终在后端计算签名。

Note

如果您还使用 Web 小组件,要求签名令牌将同时应用于两个平台:Swift SDK 需要 HMAC-SHA256 signature,而 Web 小组件需要 HS256 JWT(token)。请参阅签名身份。

服务器端签名示例

Node.js

JavaScript
import crypto from 'node:crypto';

export function signUserJotIdentity(userId, secret) {
  return crypto.createHmac('sha256', secret).update(userId).digest('hex');
}

Python

Python
import hmac
import hashlib

def sign_userjot_identity(user_id: str, secret: str) -> str:
    return hmac.new(
        secret.encode("utf-8"),
        user_id.encode("utf-8"),
        hashlib.sha256,
    ).hexdigest()

PHP

PHP
<?php

function signUserJotIdentity(string $userId, string $secret): string
{
    return hash_hmac('sha256', $userId, $secret);
}

Ruby

Ruby
require 'openssl'

def sign_userjot_identity(user_id, secret)
  OpenSSL::HMAC.hexdigest('sha256', secret, user_id)
end

SwiftUI 应用模式

Swift
@main
struct MyApp: App {
    @StateObject private var authManager = AuthManager()

    init() {
        UserJot.setup(projectId: "YOUR_PROJECT_ID")
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
                .onAppear {
                    if let user = authManager.currentUser {
                        UserJot.identify(
                            userId: user.id,
                            email: user.email
                        )
                    }
                }
        }
    }
}

后续步骤

这是否解答了您的问题?