PAGES REST API
Cloudflare Pages API
Cloudflare 页面 API
PAGES API 使您能够构建自动化并将页面与您的开发工作流集成。从较高的层面来看,API 端点允许您管理部署和构建并配置项目。Cloudflare 支持用于无头 CMS 部署的部署钩子。有关对象类型和端点的完整分类,请参阅 API 文档。
如何使用 API
获取 API 令牌
要创建 API 令牌:
- 登录到 Cloudflare 仪表板。
- 选择仪表板右上角的用户图标 > 我的个人资料。
- 选择 API 令牌 > 创建令牌。
- 您可以转到编辑 Cloudflare Workers 模板 > 使用模板,或转到创建自定义令牌 > 开始使用。如果您创建自定义令牌,则需要确保添加具有编辑访问权限的 Cloudflare 页面权限。
发出请求
创建令牌后,您可以使用请求标头中的 API 令牌对 API 进行身份验证并发出请求。例如,以下是获取项目中所有部署的 API 请求。
bash复制
$ curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/pages/projects/{project_name}/deployments' \ -H 'Authorization: Bearer {API_token}'
通过替换 {account_id}
、{project_name}
和 {API_token}
来尝试使用您自己的项目。有关更多信息,请参阅查找您的帐户 ID。
示例
当与 Cloudflare Workers 结合使用时,API 会更加强大:这是在 Cloudflare 全球网络上部署无服务器功能的最简单方法。以下部分包括有关如何使用页面 API 的三个代码示例。要构建和部署这些示例,请参阅入门指南。
每小时触发一次新构建
假设我们有一个从实时源拉取数据以编译静态输出的 CMS。您可以使用 API 定期触发新构建,从而尽可能保持静态内容的最新状态。
部署 JavaScript Worker 后,在 Worker 中设置 cron 触发器以定期运行此脚本。有关更多详细信息,请参阅 Cron 触发器。
一周后删除旧部署
Cloudflare Pages 在预览链接上托管和提供所有项目部署。假设您想保持项目的私密性,并防止访问您的旧部署。您可以使用 API 在一个月后删除部署,这样它们就不再在网上公开。无法删除分支的最新部署。
部署 JavaScript Worker 后,您可以在 Worker 中设置 cron 触发器以定期运行此脚本。有关更多详细信息,请参阅 Cron 触发器指南。
共享项目信息
假设您在使用页面构建网站的开发团队中工作。您希望能够轻松共享部署预览链接和构建状态,而无需共享 Cloudflare 帐户。使用 API,您可以轻松共享项目信息,包括部署状态和预览链接,并将此内容作为 HTML 从 Cloudflare Worker 提供。