Skip to content

考勤 SDK 接口文档

概述

考勤 SDK 提供了飞书考勤系统的完整 API 封装,支持考勤组管理、班次排班、打卡记录、考勤统计、审批补卡等功能,帮助开发者快速构建企业级考勤管理应用。

主要功能:

  • 考勤组与班次管理
  • 排班表创建与查询
  • 打卡流水记录导入与查询
  • 考勤统计报表定制与查询
  • 假勤审批数据管理
  • 补卡审批与休假管理
  • 归档报表管理
  • 用户人脸识别设置

适用场景:

  • 企业考勤管理系统集成
  • 第三方打卡设备数据同步
  • 考勤数据统计与报表分析
  • 假勤审批流程自动化

文档使用指引:

本索引文档提供了所有考勤相关 API 的导航入口。每个 API 文档包含接口名称、功能描述、函数签名、参数说明及请求示例。点击各 API 链接可查看详细文档。

快速开始

安装

bash
dotnet add package Mud.Feishu

配置文件

appsettings.json 中添加飞书应用配置:

json
{
  "FeishuApps": [
    {
      "AppKey": "default",
      "AppId": "cli_xxx",
      "AppSecret": "your_app_secret",
      "BaseUrl": "https://open.feishu.cn",
      "IsDefault": true
    }
  ]
}

注册服务

Program.cs 中注册飞书服务:

csharp
// 添加飞书服务
builder.Services.AddFeishuApp(builder.Configuration, "FeishuApps");

// 注册 API 服务
builder.Services.CreateFeishuServicesBuilder()
    .AddModules(FeishuModule.All)
    .Build();

依赖注入使用

在 Controller 或服务中通过构造函数注入接口:

csharp
using Mud.Feishu;

public class AttendanceController : ControllerBase
{
    private readonly IFeishuTenantV1AttendanceGroups _groupsApi;

    public AttendanceController(IFeishuTenantV1AttendanceGroups groupsApi)
    {
        _groupsApi = groupsApi;
    }

    [HttpGet("groups")]
    public async Task<IActionResult> GetGroups([FromQuery] int pageSize = 10)
    {
        var result = await _groupsApi.GetGroupPageListAsync(pageSize: pageSize);
        return Ok(result);
    }
}

API 接口导航

考勤组与班次管理

考勤打卡与统计

考勤审批与休假

归档报表与用户设置

命名空间与版本信息

  • 根命名空间Mud.Feishu
  • 当前版本:2.0.5
  • 目标框架:.NET Standard 2.0 / .NET 6+ / .NET 8+