验证访客身份

使用 Chatixy.identify() 告诉聊天已登录的访客是谁,并在您的服务器上对其邮箱签名,团队即可在对话中看到已验证的身份。

身份验证的工作方式

当访客已登录您的网站时,页面可以通过 Chatixy.identify() 告诉聊天此人是谁。其邮箱、姓名和电话随后会显示在收件箱的对话中,聊天也不再询问其邮箱。

没有签名时,identify() 的行为与聊天前表单相同:信息只填写空字段,对话标记为未验证。加上在您服务器上生成的签名 user_hash,Chatixy 会将身份标记为已验证:信息会替换访客填写的内容,收件箱中的联系人卡片会显示 已验证 标记。只有身份确实已验证时,您的支持代理才会被告知身份已验证。

提示

  • 聊天前表单的字段规则同样适用:只有聊天会询问电话时才保存电话号码;除非聊天的姓名字段已关闭,否则保存姓名。

找到您的身份密钥

每个聊天都有自己的 身份密钥。只有您工作区的管理员可以查看。

步骤

  1. 1

    打开聊天设置

    在项目中点击该站点的 配置,然后打开 高级设置。

  2. 2

    复制密钥

    在 身份密钥 下点击 显示,然后点击 复制。

  3. 3

    保存在服务器上

    将其保存在只有您的服务器能读取的位置,例如环境变量 CHATIXY_IDENTITY_SECRET。

重要

  • 切勿将身份密钥放在页面代码、JavaScript 或公开代码库中。任何拿到它的人都能让任意邮箱看起来已验证。
  • 重新生成 会创建新密钥,用旧密钥生成的签名会立即失效。如果密钥可能已泄露,请使用此功能,并立即将新密钥配置到服务器上。

在服务器上对邮箱签名

签名是以身份密钥为键、对访客邮箱计算的 HMAC-SHA256,用小写十六进制表示,共 64 个字符。

请对传给 identify() 的邮箱原样签名。Chatixy 在校验前不会改变字母大小写,因此 Ann@Example.com 和 ann@example.com 会得到不同的签名。请在服务器上生成签名,例如渲染页面或自己的 API 响应时,切勿在浏览器中生成。

Node.js

const crypto = require('crypto');

const userHash = crypto
  .createHmac('sha256', process.env.CHATIXY_IDENTITY_SECRET)
  .update(user.email)
  .digest('hex');

PHP

$userHash = hash_hmac('sha256', $user->email, getenv('CHATIXY_IDENTITY_SECRET'));

Python

import hashlib
import hmac
import os

user_hash = hmac.new(
    os.environ['CHATIXY_IDENTITY_SECRET'].encode(),
    user.email.encode(),
    hashlib.sha256,
).hexdigest()

Ruby

require 'openssl'

user_hash = OpenSSL::HMAC.hexdigest('SHA256', ENV.fetch('CHATIXY_IDENTITY_SECRET'), user.email)

将身份传给聊天

使用访客邮箱并将签名作为 user_hash 调用 Chatixy.identify();name 和 phone 可选。将服务器生成的值写入页面,下面的示例显示的是占位符。

页面一旦知道访客是谁即可调用。聊天就绪前的调用会等待,就绪后执行;在第一条消息之前提供的身份会关联到该消息开启的对话。

HTML

<script>
  window.chatixyAsyncInit = function (Chatixy) {
    Chatixy.identify({
      email: 'ann@example.com',
      name: 'Ann',
      user_hash: 'SIGNATURE_FROM_YOUR_SERVER',
    });
  };
</script>
<script src="https://chatixy.com/source/YOUR_WIDGET_KEY.js" async></script>

签名不匹配时

不匹配的 user_hash 不会保存该次调用的任何内容:没有邮箱、姓名、电话,也没有 已验证 标记。聊天本身照常工作,访客不会看到任何错误。

已验证的对话会保持已验证:之后不带签名的 identify() 调用无法撤销。

为什么没有显示 已验证 标记?

请检查:签名的邮箱与传入的邮箱一字不差;使用的是此聊天的密钥,因为每个聊天的密钥都不同;签名以十六进制书写;以及在您复制密钥后没有人重新生成过它。

必须对邮箱签名吗?

不必。不带 user_hash 的 identify() 仍会将访客信息传入收件箱。这些信息标记为未验证,并且只填写仍为空的字段。