跳到主要内容

Token

提示

社区版不支持,请升级到企业版或平台版。请替换licenseKey

功能简介

AccessToken 是微语系统提供的第三方登录凭证,主要用于第三方系统集成时避免用户二次登录。通过 AccessToken,第三方系统可以直接让用户登录到微语系统,无需用户重新输入用户名和密码。

token

使用场景

  • 第三方系统集成: 当您的系统需要集成微语客服功能时
  • 单点登录 (SSO): 实现用户一次登录即可访问多个系统
  • 嵌入式应用: 在您的应用中嵌入微语客服界面
  • API 调用: 通过 AccessToken 进行 API 认证,实现程序化访问微语系统的各项功能

AccessToken 登录方式

1. 获取 AccessToken

在微语管理后台的 Token 管理页面,可以生成和管理 AccessToken。

任意路径登录优势

AccessToken 支持任意路径登录,这意味着您可以直接跳转到系统的任何页面,而不仅限于登录页面。这种方式的优势包括:

  • 提升用户体验: 用户可以直接跳转到需要的功能页面,无需额外的导航步骤
  • 简化集成流程: 第三方系统可以直接链接到具体功能模块
  • 减少页面跳转: 避免先跳转到登录页面再跳转到目标页面的多余步骤
  • 精确定位: 可以将用户直接带到相关的工作页面,提高工作效率

2. 登录 URL 格式

AccessToken 支持两种登录方式,并且支持任意路径登录:

客服工作台登录

# 标准登录页面
http://服务器ip/agent/auth/login?accessToken=YOUR_ACCESS_TOKEN

# 任意路径登录(推荐)
http://服务器ip/agent/chat?accessToken=YOUR_ACCESS_TOKEN
http://服务器ip/agent/ticket?accessToken=YOUR_ACCESS_TOKEN
http://服务器ip/agent/任意路径?accessToken=YOUR_ACCESS_TOKEN

管理后台登录

# 标准登录页面
http://服务器ip/admin/auth/login?accessToken=YOUR_ACCESS_TOKEN

# 任意路径登录(推荐)
http://服务器ip/admin/welcome?accessToken=YOUR_ACCESS_TOKEN
http://服务器ip/admin/dashboard?accessToken=YOUR_ACCESS_TOKEN
http://服务器ip/admin/任意路径?accessToken=YOUR_ACCESS_TOKEN

3. 完整示例

客服工作台示例

# 标准登录页面
http://your-domain.com/agent/auth/login?accessToken=eyJhbGciOiJIUzM4NCJ9...

# 聊天页面直接登录
http://127.0.0.1:9005/agent/chat?accessToken=eyJhbGciOiJIUzM4NCJ9...

# 工单页面直接登录
http://127.0.0.1:9005/agent/ticket?accessToken=eyJhbGciOiJIUzM4NCJ9...

管理后台示例

# 标准登录页面
http://your-domain.com/admin/auth/login?accessToken=eyJhbGciOiJIUzM4NCJ9...

# 欢迎页面直接登录
http://127.0.0.1:9004/admin/welcome?accessToken=eyJhbGciOiJIUzM4NCJ9...

# 仪表盘页面直接登录
http://127.0.0.1:9004/admin/dashboard?accessToken=eyJhbGciOiJIUzM4NCJ9...

集成示例

1. 简单链接跳转

客服工作台

<!-- 标准登录页面 -->
<a href="http://your-domain.com/agent/auth/login?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开客服工作台
</a>

<!-- 直接跳转到聊天页面 -->
<a href="http://127.0.0.1:9005/agent/chat?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开客服聊天页面
</a>

<!-- 直接跳转到工单页面 -->
<a href="http://127.0.0.1:9005/agent/ticket?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开客服工单页面
</a>

管理后台

<!-- 标准登录页面 -->
<a href="http://your-domain.com/admin/auth/login?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开管理后台
</a>

<!-- 直接跳转到欢迎页面 -->
<a href="http://127.0.0.1:9004/admin/welcome?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开管理后台欢迎页
</a>

<!-- 直接跳转到仪表盘 -->
<a href="http://127.0.0.1:9004/admin/dashboard?accessToken=YOUR_ACCESS_TOKEN" target="_blank">
打开管理后台仪表盘
</a>

2. JavaScript 跳转

// 打开客服工作台(标准登录)
function openAgentWorkspace(accessToken) {
const url = `http://your-domain.com/agent/auth/login?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 打开客服聊天页面(任意路径登录)
function openAgentChat(accessToken) {
const url = `http://127.0.0.1:9005/agent/chat?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 打开客服工单页面(任意路径登录)
function openAgentTicket(accessToken) {
const url = `http://127.0.0.1:9005/agent/ticket?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 打开管理后台(标准登录)
function openAdminPanel(accessToken) {
const url = `http://your-domain.com/admin/auth/login?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 打开管理后台欢迎页(任意路径登录)
function openAdminWelcome(accessToken) {
const url = `http://127.0.0.1:9004/admin/welcome?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 打开管理后台仪表盘(任意路径登录)
function openAdminDashboard(accessToken) {
const url = `http://127.0.0.1:9004/admin/dashboard?accessToken=${accessToken}`;
window.open(url, '_blank');
}

// 使用示例
const accessToken = 'YOUR_ACCESS_TOKEN';
openAgentChat(accessToken); // 直接打开聊天页面
openAgentTicket(accessToken); // 直接打开工单页面
openAdminWelcome(accessToken); // 直接打开管理后台欢迎页
openAdminDashboard(accessToken); // 直接打开管理后台仪表盘

3. iframe 嵌入

客服工作台

<!-- 标准登录页面 -->
<iframe
src="http://your-domain.com/agent/auth/login?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

<!-- 直接嵌入聊天页面 -->
<iframe
src="http://127.0.0.1:9005/agent/chat?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

<!-- 直接嵌入工单页面 -->
<iframe
src="http://127.0.0.1:9005/agent/ticket?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

管理后台

<!-- 标准登录页面 -->
<iframe
src="http://your-domain.com/admin/auth/login?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

<!-- 直接嵌入欢迎页面 -->
<iframe
src="http://127.0.0.1:9004/admin/welcome?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

<!-- 直接嵌入仪表盘 -->
<iframe
src="http://127.0.0.1:9004/admin/dashboard?accessToken=YOUR_ACCESS_TOKEN"
width="100%"
height="600px"
frameborder="0">
</iframe>

常用 API 端点示例

  • 工单管理: /api/tickets/* - 工单的增删改查操作
  • 用户管理: /api/users/* - 用户信息管理
  • 消息管理: /api/messages/* - 消息发送和查询
  • 统计报表: /api/statistics/* - 数据统计和报表
  • 系统配置: /api/settings/* - 系统配置管理

安全注意事项

  1. Token 保护: AccessToken 具有登录权限,请妥善保管,不要泄露给他人
  2. HTTPS 传输: 建议在生产环境中使用 HTTPS 协议传输 AccessToken
  3. Token 有效期: 注意 AccessToken 的有效期,过期需要重新生成
  4. 域名限制: 可以在管理后台设置 Token 的允许访问域名,确保安全性
  5. 定期更新: 建议定期更新 AccessToken 以提高安全性

错误处理

常见错误及解决方案

  1. Token 无效

    • 检查 AccessToken 是否正确
    • 确认 Token 是否已过期
    • 验证 Token 是否被禁用
  2. 访问被拒绝

    • 检查当前域名是否在允许列表中
    • 确认 Token 的权限设置
  3. 登录失败

    • 检查服务器地址是否正确
    • 确认网络连接正常

相关文档

这页文档对您有帮助吗?