Skip to content

组织架构概述

管理后台-组织架构OpenAPI服务于企业管理员,对飞书中的组织架构数据进行管理操作。例如:

  • 创建、更新、查询、删除部门
  • 创建、更新、查询、离职、恢复员工

你可以在 API列表 中查看组织架构的具体开放能力

适用场景

组织架构功能的应用场景多样,下面列举几个典型的应用场景。

场景一:HR系统集成飞书

在企业的HR系统中完成入转调离之后,需要同步处理飞书账号的信息与状态变更。如果依靠HR手动维护,不仅费时费力,还容易出错遗漏。此时,可以通过组织架构的API来实现数据同步。

首先需要创建一个飞书应用,其次确定要调用的组织架构API,然后开启应用的权限并获取应用访问凭证,在入转调离完成时对部门、员工进行操作,以及查看同步完成的组织架构。

场景二:开发企业应用

企业要开发自建应用时,如果需要获取组织架构或员工数据,可以使用组织架构API。注意使用组织架构API查询数据时,除了需要获取接口权限,还需要获取具体的字段对应的权限。

场景三:管理员操作

管理员除了可以飞书管理后台维护组织架构数据,还可以通过调用API来进行操作。注意当使用管理员的访问凭证调用API时,只有在管理后台有同等操作权限时才能调用成功,并且可操作的成员、部门范围也会遵循管理员的管理范围。

资源介绍

组织架构以资源为中心进行开发,当前已经开放的资源和关系如下:

WechatIMG212.jpeg

权限要求

通讯录权限范围定义了应用调用组织架构接口能获取哪些部门和用户数据,不在应用获取通讯录范围内的数据是无法访问的。

如下图所示,组织架构中有 A、B、C 三个部门,若一个应用只有 B 和 C 两个部门的通讯录权限,那么该应用就只能通过接口获取到 B 和 C 两个部门的数据,获取 A 部门就会报出没有权限的错误。有关通讯录权限范围的详细介绍,请参考通讯录权限范围简介

接入流程

步骤介绍
创建一个应用如需创建企业自建应用,可参考 自建应用的开发流程
如需创建应用商店应用,可参考 开发和上架应用商店应用
调用API,对组织架构进行操作调用 API 前,你需要先获取访问凭证并开启对应的权限,详情参见 如何调用服务端API
你还可以在 API 调试台中快速调试这些 API ,使用方法参见API 调试台使用指南
监听事件,获知组织架构的变化组织架构当前尚未提供事件,如需监听组织架构的变更,可以先使用 通讯录事件
监听事件前,你需要先申请相应的权限,详情参见 事件订阅概述

频控要求

不同的组织架构 OpenAPI 设定了不同级别的频控控制策略,你可以在每个接口文档中找到接口频率限制信息,频控策略 文档中也说明了在调用 OpenAPI 遇到频控限制时应该如何处理。

频控策略概览

组织架构接口采用应用级+企业级双重限制

  • 单应用调用接口超出接口预设阈值时,触发应用级限制
  • 同一企业下多个应用调用同一接口时,累计触发企业级限制
  • 全平台所有企业同时调用同一接口时,累计触发平台级限制

接口分类说明

接口的频率限制大概的逻辑如下:

接口类型频率限制典型接口示例
数据写入单企业单应用 5 次/秒创建员工、创建部门
数据修改单企业单应用 10 次/秒更新员工、离职员工、恢复离职员工、更新部门、删除部门
数据读取单企业单应用 1000 次/分钟、50 次/秒批量获取员工信息、批量获取员工列表、搜索员工、批量获取部门信息、批量获取部门列表、搜索部门

内容来源:飞书开放平台 · 自动爬取整理