第 14 章 导出和导入开发人员门户


作为 3scale API 供应商,您可以导出和导入开发人员门户,以满足以下目的:

  • 创建备份.
  • 将开发人员门户保留在外部存储库中,如 GitHub。
  • 将开发人员门户与其他应用程序集成.

使用 Developer Portal API 作为内容管理系统(CMS)来导入和导出 Development Portal 内容。为此,请执行以下步骤来生成具有足够权限的密钥,以使用开发人员门户 API。

流程

  1. 导航到 Account settings > Personal > Tokens,再点 Add Access Token
  2. 将访问令牌命名为,并检查 Developer Portal API
  3. 选择权限:

    1. Read only 仅允许检索开发人员内容门户内容。
    2. 读和写 允许检索和恢复开发人员门户内容。
  4. 单击 Create Access token
  5. 复制并存储显示的令牌信息。

检查在左侧面板中导航到 Integrate > 3scale API Docs 的端点列表。然后,向下滚动到 Developer Portal API。使用生成的令牌来调用每个端点,并根据您的需要填写字段。

开发者门户 API 端点注意事项

3scale 2.14 提供的 Developer Portal API 与之前的版本不兼容。另外,从 3scale 2.14 开始,JSON 是唯一兼容所有请求和响应的数据格式。

对于每个端点,您可以执行以下操作:

  • GET 来读取和列出资源。
  • POST 用于创建和添加资源。
  • PUT 来修改资源。
  • DELETE 删除资源。
注意
  • 无法删除内置对象。使用 type=builtin_page 参数调用 GET /admin/api/cms/templates 端点,以获取内置页面的列表和 type=builtin_partial 参数,以获取内置部分的列表。
  • 要进行完整备份,您必须调用每个内容。没有 API 端点可以下载包含所有文件的完整存档。
  • 如果未发送 内容,则不会返回已发布或草案内容。相反,它会返回一个摘要,其中包含模板名称和部分的信息,因为内容太长。

使用每个端点中列出的详情,在执行后优化其输出。对于列出的参数,请考虑以下几点:

  • 所有端点都拒绝不支持的参数;如果发送不支持的参数,则请求将被取消。
  • GET /admin/api/cms/templates 端点接受 content 参数。默认情况下,它返回 Developer Portal 模板列表。要也获得发布和草稿内容,请使用 content=true 参数。
  • GET /admin/api/cms/templates 端点接受 typesection_id 参数来过滤结果。
  • GET /admin/api/cms/sections 端点接受 parent_id 参数来过滤结果。
  • GET /admin/api/cms/files 端点接受 section_id 参数来过滤结果。
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat