注意:此产品的某些方面处于 Beta 版阶段。Hybrid 安装选项是 GA。要加入 Beta 版计划,请与您的 Apigee 代表联系。

门户用户如何与您的门户互动

通过开箱即用的开发者门户,您的门户用户可以创建开发者帐号、登录帐号并管理将会消耗您的 API 的应用。

以下各部分介绍了门户用户如何与您的门户互动。

登录门户

以下各部分介绍了门户用户如何使用其用户凭据(内置身份提供商)或 SAML(Beta 版)登录集成式门户。

如果您同时启用内置身份和 SAML 身份提供商,则门户用户将能够选择自己喜欢的登录方法。例如:

同时启用了用户凭据和 SAML 身份验证的“登录”对话框

使用用户凭据(内置身份提供商)登录门户

启用内置身份提供商后,门户用户可以使用其用户凭据(用户名和密码)登录集成式门户,如以下各部分所述:

在集成式门户上创建开发者帐号

通过内置身份提供商服务,门户用户必须先在集成式门户上创建一个开发者帐号,然后才能使用您的 API。

门户用户可在集成式门户上创建开发者帐号,如下所示:

  1. 导航到门户。
  2. 点击登录

    系统会显示“登录”页面。

  3. 点击创建帐号

    系统会显示“创建帐号”页面。

    “创建帐号”对话框

  4. 填写表单。

    您必须为所有必填字段输入值。密码必须至少包含 8 个字符,并且至少包含 1 个数字、1 个小写字母、1 个大写字母和 1 个特殊字符。

  5. 查看并同意条款及条件。

  6. 点击创建帐号

    注意:如果您尝试使用电子邮件 ID 创建已注册过的帐号,则系统会显示一条消息,指出该帐号已存在,并建议您改为以门户用户身份登录。

  7. 填写人机识别系统表单,然后点击验证(如果显示)。

    系统会创建开发者帐号,并发送确认电子邮件。

    注意:您可以配置确认电子邮件,如配置电子邮件通知所述。如配置 SMTP 服务器所述,Apigee 建议您在发布来自门户的电子邮件通知之前先配置用于这些通知的 SMTP 服务器。

  8. 在 10 分钟内,点击确认电子邮件中的链接即可完成注册过程。

    如果未在 10 分钟内点击链接,您必须重复执行此过程中的步骤以创建一个帐号且您会重新收到系统提示。

  9. 登录集成式门户(如下所述)。

登录集成式门户

借助内置身份提供商,门户用户在集成式门户上注册并获得批准后,即可使用其凭据(用户名和密码)登录。

门户用户会以如下方式登录:

  1. 导航到门户。
  2. 点击登录
  3. 输入电子邮件地址和密码。
  4. 点击登录

更改密码

通过内置的身份提供商,门户用户可按如下方式更改密码:

  1. 导航到门户。
  2. 点击登录
  3. 点击重置密码
  4. 输入要重置的帐号的电子邮件地址。
  5. 点击发送密码重置链接

    系统会将重置密码链接发送至电子邮件。

    注意:要配置 SMTP 服务器,请参阅配置 SMTP 服务器

  6. 点击确认电子邮件中的链接。

  7. 输入新密码并确认。

    密码必须至少包含 8 个字符,并且至少包含 1 个数字、1 个小写字母、1 个大写字母和 1 个特殊字符。

  8. 点击创建新密码

使用 SAML 身份验证(Beta 版)登录门户

启用 SAML身份提供商后,门户用户可以使用 SAML 身份验证登录集成式门户,如下所示:

  1. 导航到门户。
  2. 点击登录
  3. 点击使用 SAML 登录

    系统会将您重定向至 SAML 提供商。

  4. 如果出现提示,请为您的 SAML 身份提供商输入您的凭据。

查看 API 参考文档

门户用户可以查看您已发布到您的门户的 API 参考文档,如下所示:

  1. 导航到门户。
  2. 在顶部导航栏中,点击 API
    系统会显示 API 页面。例如:

    API 页面

  3. 如果需要,可使用左侧窗格中的工具按类别、标题或说明过滤 API 列表。

  4. 点击 API 卡片以查看 API 参考文档。

    系统会显示 API 参考文档。门户用户可以了解并试用 API。

  5. 要试用 API,您可能需要授权:

    a.在顶部导航栏中,点击授权
    b. 输入所需的凭据。
    c. 点击授权
    d. 点击确定

点击下载规范以下载用于呈现 API 参考文档的 OpenAPI 规范。如需详细了解如何呈现 API 参考文档,请参阅发布 API

注册应用

门户用户可以注册应用以便使用您已发布的 API,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 点击 + 新应用以创建新的应用。
  3. 在“新应用”对话框中输入应用的名称和说明。
  4. 在“API 目录”部分,选择一个或多个 API。

    目录中的 API 归类为“经过身份验证的 API”,需要回调网址或公共 API。您必须至少选择一个 API 才能创建应用。

  5. 如果您在“经过身份验证的 API”部分中选择某个 API,请输入回调网址。

    如需了解详情,请参阅回调网址简介

  6. 点击创建

在应用中管理 API

作为 API 提供商,您可以发布 API,使门户用户能够使用您的 API 产品。

门户用户可以管理其应用使用哪些 API。这些 API 会添加到应用详情页面。对于某些 API,审批不会自动进行。待处理状态表示您已请求访问权限但尚未授予访问权限的 API。

门户用户可以通过您的门户在应用中管理 API,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 在列表中点击该应用。
  3. 在 API 部分,点击 启用图标停用图标 以通过应用分别启用或停用 API 的访问权限。
  4. 对于经过身份验证的 API,根据需要添加或修改回调网址。

查看应用的 API 密钥和密文

门户用户可以从您的门户管理应用的 API 密钥,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 在列表中点击该应用。
  3. 在 API 密钥部分中查看 API 密钥。
  4. 确认 API 密钥的状态为“有效”。
  5. 点击显示密文以查看密文。
  6. 将光标悬停在 API 密钥或密文上,然后点击 “删除”图标 以将其复制到剪贴板。

轮替应用的 API 密钥

门户用户可以定期轮替应用的 API 密钥,或响应潜在的泄露或危害。当门户用户轮替 API 密钥时,系统将使用与原始密钥相同的 API 授权创建新的 API 密钥。当您不再使用原始 API 密钥时它仍处于活跃状态。您必须按照撤消应用的 API 密钥所述,来撤消旧 API 密钥以防止系统接受其凭据。

门户用户可以通过您的门户来轮替应用的 API 密钥,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 在列表中点击该应用。
  3. 在“API 密钥”部分中,点击添加密钥
  4. 点击对话框中的确认以确认操作。
  5. (可选)撤消旧 API 密钥,如下所述。

撤消应用的 API 密钥

当门户用户轮替 API 密钥时(如上一部分所述),API 密钥会在停止使用时仍然处于活跃状态。您必须撤消 API 密钥才能阻止系统接受其凭据。

门户用户可以通过您的门户来撤消应用的 API 密钥,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 点击该应用的名称。
  3. 在“API 密钥”部分中,点击与您要撤消的 API 密钥关联的“操作”列中的 撤消图标
  4. 点击确认以确认操作。

    密钥的状态已更新为“已撤消”。

修改应用详情

门户用户可以修改应用详情,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 在列表中点击该应用。
  3. 在“应用详情”标签页上修改“名称”或“说明”字段。
  4. 根据需要管理应用中的 API
  5. 点击保存

删除应用

门户用户可以从您的门户中删除应用,如下所示:

  1. 从开发者帐号下拉列表中选择应用
  2. 在列表中点击该应用。
  3. 点击删除
  4. 点击确认以确认操作。

系统会删除该应用,并将其从应用列表中移除。