第 14 章 导出和导入开发人员门户
作为 3scale API 供应商,您可以为以下目的导出和导入开发人员门户:
- 创建备份.
- 将开发人员门户保留在外部存储库中,如 GitHub。
- 将开发人员门户与其他应用程序集成.
使用 Developer Portal API 作为内容管理系统(CMS)导入和导出开发门户内容。为此,请执行以下步骤生成具有足够权限的密钥以使用 Developer Portal API。
流程
- 导航到 Account settings > Personal > Tokens,再点 Add Access Token。
- 将访问令牌命名为,并检查 Developer Portal API。
选择权限:
- 只读 允许检索开发人员内容。
- 读和写 允许检索和恢复开发人员门户内容。
- 单击 Create Access token。
- 复制和存储显示的令牌信息。
检查从左侧面板浏览的端点列表,以 integrate & gt; 3scale API Docs。然后,向下滚动到 Developer Portal API。使用生成的令牌来调用每个端点,并根据您的需要填写字段。
开发者门户 API 端点注意事项
3scale 2.14 提供的开发者门户 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
端点接受内容
参数。默认情况下,它会返回一个 Developer Portal 模板列表。要同时发布和草案内容,请使用content=true
参数。 -
GET /admin/api/cms/templates
端点接受type
和section_id
参数来过滤结果。 -
GET /admin/api/cms/sections
端点接受parent_id
参数来过滤结果。 -
GET /admin/api/cms/files
端点接受section_id
参数来过滤结果。