API文档

概述

此接口用于通过软件ID和用户验证TOKEN检查用户是否在线。

请求参数

参数	类型	描述	必需
software_id	字符串	软件的ID	是
token	字符串	用户验证的TOKEN	是

TIP

token 参数是由客户端接口提供，以下是一个获取 token 的示例

public static void main(String[] args) {
    String token = Wrapper.getVerifyToken(); 
    // 您的业务代码 ...
}

请求示例

void userOnline() {
    Map<String, String> params = new HashMap<>();
    params.put("software_id", "软件的ID");
    params.put("token", "用户token");
    String result = HttpUtils.post(URL + "user-online", params, header());
    System.out.println(result);
}

请求头

API调用应包含用于授权的请求头。这些将通过上述用例中的header()方法获得。

预期结果

数据对象

字段名	类型	描述
user_id	整数	用戶的UID
username	字符串	用戶名
software_id	整数	在线的软件ID
create_time	时间戳	用户上线时间

结果示例

{
  "code": 0,
  "message": "成功",
  "entity": {
    "data": {
      "user_id": 1,
      "username": "imfl0wow",
      "software_id": 1,
      "create_time": 1712041058922
    }
  }
}

应用场景

当客户端应用程序需要验证用户当前是否在线并正在使用特定软件时，可能会使用此 API 调用。

当您对接您的 IRC 服务器时，您可以使用此 API 校验登录有效性与在线状态。