VerifyGuard API Documentation

API接口文档 v1.2.0

📋 快速导航

📖 概述

本系统提供了完整的RESTful API接口，支持企业微信用户管理、状态查询和系统监控功能。所有API接口都返回统一的JSON格式响应。

ℹ️ 基础信息

API基本信息

  • API版本: 1.2.0
  • 基础URL: https://your-domain.com/api.php
  • 响应格式: JSON
  • 字符编码: UTF-8

📝 更新日志

v1.2.0 (2025-12-02)

  • ✨ 新增系统更新日志管理功能，支持后台可视化增删改查
  • 📝 前端首页新增更新日志时间轴展示
  • 🎨 管理后台UI样式深度标准化，移除冗余内联样式
  • 📚 API文档同步更新，新增版本记录与更新日志章节
  • 🔧 优化系统配置文件结构

v1.1.0 (2025-11-30)

  • ✨ 新增全站水印功能，支持显示用户身份信息
  • 🔐 新增身份验证页面，增强登录安全性
  • 🎨 全新UI设计，统一移动端和PC端视觉风格
  • 📱 优化移动端登录申请流程
  • 🛠️ 修复审批状态同步问题
  • ⚡ 优化回调处理逻辑
  • 🔒 增强系统安全性，限制敏感配置可见性

v1.0.0 (2025-06-30)

  • 🚀 初始版本发布
  • ✨ 支持基本的二次验证功能
  • 👥 用户注册和管理
  • 🛡️ 完整的错误处理

📄 响应格式

所有API接口都返回以下格式的JSON响应：

{
  "success": true,
  "message": "操作成功",
  "timestamp": 1640995200,
  "data": {
    // 具体的响应数据
  }
}

字段说明

字段 类型 说明
success 布尔值 表示操作是否成功
message 字符串 响应消息
timestamp 整数 响应时间戳
data 对象/数组 具体的响应数据

🔍 系统状态查询

GET /api.php?path=status

描述: 获取系统运行状态、配置信息和API状态

请求参数: 无

响应示例:

{
  "success": true,
  "message": "系统状态获取成功",
  "timestamp": 1640995200,
  "data": {
    "system": {
      "name": "VerifyGuard",
      "version": "1.2.0",
      "php_version": "8.0.0",
      "server_time": "2024-01-01 12:00:00",
      "timezone": "Asia/Shanghai"
    },
    "config": {
      "corp_id": "ww3b49736761649312",
      "agent_id": "1000013",
      "log_enabled": true,
      "log_writable": true
    },
    "api": {
      "access_token_valid": true,
      "access_token": "ACCESS_TOKEN_PREFIX...",
      "last_error": null
    }
  }
}

👤 用户信息查询

GET /api.php?path=user/info

描述: 根据用户ID获取详细信息

请求参数:

参数名 类型 必填 说明
userid 字符串 必填 用户ID

请求示例: GET /api.php?path=user/info&userid=zhangsan

响应示例:

{
  "success": true,
  "message": "用户信息获取成功",
  "timestamp": 1640995200,
  "data": {
    "userid": "zhangsan",
    "name": "张三",
    "mobile": "13800138000",
    "department": [1, 2],
    "position": "产品经理",
    "gender": "1",
    "email": "zhangsan@company.com",
    "enable": 1,
    "avatar": "http://wx.qlogo.cn/..."
  }
}

📋 用户列表查询

GET /api.php?path=user/list

描述: 获取指定部门的用户列表

请求参数:

参数名 类型 必填 默认值 说明
department_id 整数 可选 1 部门ID
fetch_child 整数 可选 0 是否获取子部门用户，0或1

➕ 创建用户

POST /api.php?path=user/create

（更多接口详情请参考源代码或联系开发人员）

↑