API 密钥 | Fern Documentation

管理员可以在 Fern Dashboard 中创建和管理 API 密钥。API 密钥用于在 CI/CD 流水线中验证 Fern CLI 身份，例如从 GitHub Actions 发布 SDK 或文档时。

在 Fern Dashboard 中创建和删除 API 密钥

API 密钥不会过期。请定期轮换密钥并删除不再使用的密钥。

创建 API 密钥

导航到 Fern Dashboard 并从侧边栏选择 API Keys。

选择 Create key，输入名称（例如 CI/CD pipeline），然后选择 Generate。

API 密钥仅显示一次。请立即复制；之后将无法再次查看。

在 CI/CD 提供商（例如 GitHub Actions、GitLab CI）中将 API 密钥添加为名为 FERN_TOKEN 的仓库密钥。Fern CLI 从环境中读取此值进行身份验证，因此任何运行 fern 命令的工作流都可以引用它：

GitHub Actions 示例

1 env:
2   FERN_TOKEN: ${{ secrets.FERN_TOKEN }}

工作流的其余部分取决于您发布的内容：同一个令牌可用于发布文档和将 SDK 发布到包注册表的身份验证。

在 API Tokens 页面中，您可以：

所有成员都可以查看 API 密钥名称和创建日期。只有管理员可以创建或删除 API 密钥。