用途:帮助开发者在 Figma Enterprise 或 Organization 计划下,通过 REST API 构建 OAuth 2.0 集成并管理组织级访问权限。
主要能力:
- OAuth 2.0 授权码流程:构造授权 URL(scope 如 file_content:read、file_comments:write、file_variables:read),用 POST https://api.figma.com/v1/oauth/token 换取 access_token 与 refresh_token,并用 /v1/oauth/refresh 刷新。授权码需在 30 秒内兑换。
- 回调处理:校验 state 防 CSRF,用 /v1/me 获取用户信息,加密存储令牌。
- 团队与项目管理:GET /v1/teams/:team_id/projects 列出项目,GET /v1/projects/:project_id/files 列出文件,GET /v1/teams/:team_id/components 与 /styles 获取已发布组件与样式。
- Variables API(仅企业版):GET /v1/files/:key/variables/local 与 /published 读取变量,POST /v1/files/:key/variables 批量增删改;非企业版返回 403。
- 访问控制中间件:以用户令牌请求文件,403 即表示无权限,可据此实现文件级 RBAC。
使用方式:需先注册 OAuth 应用并配置环境变量 FIGMA_CLIENT_ID、FIGMA_CLIENT_SECRET、FIGMA_REDIRECT_URI。示例命令:curl -s -H "Authorization: Bearer ${FIGMA_OAUTH_TOKEN}" https://api.figma.com/v1/me | jq '{handle, email}'。
适用场景:构建面向用户的 Figma 集成、按用户权限展示团队/项目/文件、读取或同步设计变量。
限制:Variables API 仅企业版可用,非企业版可改用 styles API;团队组件为空通常因未发布组件;刷新令牌被撤销需重新走 OAuth。资料未提供具体收费与价格信息。