一、功能简介
考勤 API 提供了丰富的接口开放能力,开发者通过 API 接口,可以获取授权范围内的用户打卡结果、打卡流水记录、考勤组详情、排班详情等信息;也可以创建、修改及删除考勤组、班次等内容。
二、操作流程
API 接入开发流程
- 进入 飞书开放平台 > 开发者后台。
- 在开放平台页面,点击 创建应用:
- 选择 企业自建应用;
- 填写应用名称,建议填写“打卡 API”;
- 填写应用副标题,建议填写“创建开发者账号”;
- 点击 确定创建,生成应用。
- 在开放平台页面,点击已创建的应用:
- 查看 App ID 和 App Secret;
- 上传一个新的应用图标;
- 点击 安全设置,设置打卡 API 调用的 IP 白名单。
- 在开放平台页面,开通假勤应用的读和写权限:
- 点击 权限管理,开通“假勤”应用的读写权限。
- 在开放平台页面,发布自建应用:
- 点击 应用功能 > 机器人,启用机器人;
- 点击 版本管理与发布,发布一个版本;
- 若企业设置了发布审核,需待企业管理员审核通过,该应用的开发者账号才可生效。
注:若未完成 API 接入,在访问考勤开放接口时,会返回 code:1220004 的错误。
事件订阅开发流程
- 进入 飞书开放平台 > 开发者后台。
- 在开放平台页面,点击 创建应用(若在 API 接入开发中已创建,则可跳过此步骤):
- 选择 企业自建应用;
- 填写应用名称,建议填写“打卡 API”;
- 填写应用副标题,建议填写“创建开发者账号”;
- 点击 确定创建,生成应用。
- 在开放平台页面,开通假勤应用的读和写权限(若在 API 接入开发中已开通,则可跳过此步骤):
- 点击 权限管理,开通“假勤”应用的读写权限。
- 在开放平台页面,订阅事件
- 点击 事件订阅,在“请求网址 URL”处填写回调地址;
- 添加事件,选择考勤,并选择需要的子事件。
- 在开放平台页面,发布自建应用
- 点击 应用功能 > 机器人,启用机器人(若在 API 接入开发中已启用,则可跳过此步骤)
- 点击 版本管理与发布,发布一个版本;
- 若企业设置了发布审核,需待企业管理员审核通过,该应用的开发者账号才可生效。