Cloudflare 中文文档
Pages
编辑这个页面
跳转官方原文档
Set theme to dark (⇧+D)

REST API

Pages API使你能够构建自动化,并将 Pages 与你的开发工作流集成。在高层次上,API 接口可让你管理部署和构建并配置项目。Cloudflare 支持用于headless CMS 部署的 Deploy Hooks。请参阅 API 文档 了解对象类型和接口的完整分类。

​​ 如何使用应用程序接口

​​ 获取应用程序接口令牌

创建 API 令牌

  1. 登录 Cloudflare 仪表板
  2. 选择仪表板 > 我的个人资料右上方的用户图标。
  3. 选择 API 令牌 > 创建令牌
  4. 你可以转到 编辑 Cloudflare Workers模板 > 使用模板或转到 创建自定义令牌> 开始。如果创建自定义令牌,则需要确保添加Cloudflare 页面权限和编辑访问权限。

​​ 请求

创建令牌后,你就可以使用请求headers中的 API 令牌对 API 进行身份验证和发出请求。例如,下面是一个获取项目中所有部署的 API 请求。

替换 {account_id}{project_name}<API_TOKEN>,使用你的一个项目进行尝试。更多信息请参阅 查找账户 ID

​​ 示例

当 API 与 Cloudflare Workers(在 Cloudflare 全球网络上部署无服务器功能的最简单方法)结合使用时,功能会更加强大。以下部分包括如何使用页面 API 的三个代码示例。要构建和部署这些示例,请参阅 入门指南

​​ 每小时触发一次新的构建

假设我们有一个从实时源提取数据来编译静态输出的内容管理系统。你可以通过使用 API 定期触发新的编译,尽可能保持静态内容的最新状态。

部署 JavaScript Worker 后,在 Worker 中设置一个 cron 触发器来定期运行此脚本。详情请参阅 Cron Triggers

​​ 一周后删除旧部署

Cloudflare Pages 在预览链接上托管并提供所有项目部署。假设你想保持项目的私密性,防止他人访问你的旧部署。你可以使用 API 在一个月后删除部署,使其不再在线公开。分支的最新部署无法删除。

部署 JavaScript Worker 后,可以在 Worker 中设置一个 cron 触发器来定期运行该脚本。详情请参考 Cron Triggers guide

​​ 共享项目信息

想象一下,你在一个使用 Pages 构建网站的开发团队中工作。你希望有一种简单的方式来共享部署预览链接和构建状态,而无需共享 Cloudflare 账户。使用 API,你可以轻松共享项目信息,包括部署状态和预览链接,并从 Cloudflare Worker 以 HTML 的形式提供这些内容。

​​ 相关资源