AuthGuard

快速开始

欢迎使用 AuthGuard！本指南将帮助您在 5 分钟内完成集成。

1. 注册账号

访问 AuthGuard 并注册一个开发者账号。

2. 创建应用

登录后，在控制台创建您的第一个应用：

  1. 点击"创建应用"按钮
  2. 输入应用名称和描述
  3. 获取 AppKey 和 AppSecret

3. 安装 SDK

Python

pip install authguard-sdk

Node.js

npm install authguard-sdk

C#

dotnet add package AuthGuard.SDK

4. 初始化客户端

Python 示例

from authguard import AuthGuardClient

# 初始化客户端
client = AuthGuardClient(
    app_key="your_app_key",
    app_secret="your_app_secret"
)

# 用户登录验证
try:
    result = client.init(
        username="user123",
        password="password123"
    )
    
    print(f"登录成功！Token: {result['token']}")
    
    # 保持心跳
    while True:
        client.heartbeat()
        time.sleep(60)  # 每60秒发送一次心跳
        
except AuthGuardException as e:
    print(f"验证失败: {e}")

Node.js 示例

const { AuthGuardClient } = require('authguard-sdk');

// 初始化客户端
const client = new AuthGuardClient({
  appKey: 'your_app_key',
  appSecret: 'your_app_secret'
});

// 用户登录验证
async function login() {
  try {
    const result = await client.init({
      username: 'user123',
      password: 'password123'
    });
    
    console.log(`登录成功！Token: ${result.token}`);
    
    // 保持心跳
    setInterval(async () => {
      await client.heartbeat();
    }, 60000); // 每60秒发送一次心跳
    
  } catch (error) {
    console.error(`验证失败: ${error.message}`);
  }
}

login();

5. 添加用户

在控制台的"用户管理"页面添加应用用户：

  1. 选择您的应用
  2. 点击"添加用户"
  3. 输入用户名和密码
  4. 设置过期时间和设备数限制（可选）

6. 测试验证

运行您的应用程序，使用刚才创建的用户名和密码进行登录验证。

常见问题

验证失败怎么办？

  1. 检查 AppKey 和 AppSecret 是否正确
  2. 确认用户名和密码是否正确
  3. 检查用户是否被封禁或已过期
  4. 查看设备数量是否达到上限

如何保持在线状态？

定期调用 heartbeat() 方法（建议每 60 秒一次）。如果超过 5 分钟未发送心跳，用户将被标记为离线。

如何解绑设备？

client.logout()  # 解绑当前设备

下一步

需要帮助？