应用开发者如何与您的门户互动(原始版本)

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。
信息

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

以下各部分介绍了应用开发者如何与您的门户互动:

Edge 如何跟踪应用开发者注册和登录

在 Edge 中,开发者注册和门户登录是使用 _apiportal 自定义属性进行跟踪的。

当开发者自行注册时,系统会将 _apiportal 自定义属性添加到开发者配置中,并将开发者状态设置为 unverified,以指示开发者尚未登录门户。例如:{"status":"unverified","portals":{}}

开发者首次登录门户时,系统会更新 _apiportal 自定义属性,以跟踪门户名称和访问时间,并将开发者状态设为 active。每当开发者登录门户时,系统都会更新自定义属性,以重置该门户的 lastVisit 值(采用公元纪年格式)。例如 {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

注册应用开发者账号

应用开发者必须先创建账号进行注册,然后才能使用您的 API。

当应用开发者在您的门户中注册时:

或者,您也可以使用 Edge 界面代表应用开发者注册,如注册应用开发者中所述。

新应用开发者可以通过您的门户自行注册,具体步骤如下:

  1. 导航到门户。
  2. 点击登录。
  3. 点击注册。
    系统会显示以下对话框。

    创建账号

  4. 输入所需信息(名字、姓氏和电子邮件地址)。

  5. 点击创建。
    系统会显示以下对话框。

    登录门户

  6. 点击电子邮件中的安全链接,打开门户并建立经过身份验证的会话。

登录您的门户

应用开发者在您的门户上注册后,可以使用“登录”页面登录。

每当应用开发者登录门户时,系统都会发送一个安全链接,以验证身份并与门户建立会话,而不是使用密码等共享密钥对开发者进行身份验证。

应用开发者可以按如下方式登录您的门户:

  1. 导航到门户。
  2. 点击登录。
  3. 输入与该账号关联的电子邮件地址。
  4. 点击 Login(登录)。
    系统会显示以下对话框。

    登录门户

  5. 点击电子邮件中的安全链接,打开门户并建立经过身份验证的会话。

注册应用

登录门户后,应用开发者可以注册应用以使用您已发布的 API 产品,如下所示:

  1. 从用户下拉菜单中选择我的应用。
  2. 点击 + 应用以创建新的应用。
  3. 在“创建应用”对话框中输入应用的名称和说明。
  4. 点击创建。
  5. 在应用中管理 API 产品,如下所述。

在应用中管理 API 产品

应用开发者可以在其应用中管理 API 产品。系统会将 API 产品添加到应用详情页面。对于某些 API 产品,审批不会自动进行。待处理状态表示您已请求访问权限但尚未授予访问权限的 API 产品。

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

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 点击管理商品。
  4. 点击访问切换开关以通过应用启用或停用 API 产品的访问权限。

    注意:如果应用开发者停用了仅限“专用”或“内部”的 API 访问权限,则系统将从应用中移除该 API,而且必须由门户管理员手动重新添加,如注册应用和管理 API 密钥中所述。

  5. 点击请求,为尚未获准使用的 API 产品申请批准。

  6. 点击保存。

查看应用的 API 密钥

应用开发者可以通过您的门户管理应用的 API 密钥,如下所示:

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 在密钥部分中查看 API 密钥。
  4. 点击查看 Secret 以显示 API 密钥 Secret。
  5. 确认 API 密钥的状态为“已批准”。

轮替应用的 API 密钥

应用开发者可以定期轮替应用的 API 密钥,或响应潜在的泄露或危害。当应用开发者轮替 API 密钥时,系统将使用与原始密钥相同的 API 产品授权创建新的 API 密钥。原始 API 密钥会被标记为已废弃,但在您停止使用它时仍处于活跃状态。您必须停用已废弃的密钥,以防止系统接受其凭据,如停用应用的 API 密钥中所述。

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

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 在“密钥”部分,将光标悬停在当前 API 密钥上,以显示操作菜单。
  4. 点击 展开图标 以展开操作菜单。
  5. 点击旋转。
  6. 点击对话框中的创建以确认操作。
  7. (可选)停用 API 密钥,如下所述。

停用应用的 API 密钥

当应用开发者轮替 API 密钥时(如上一部分所述),API 密钥会被标记为已废弃,但在您停止使用它时仍处于活跃状态。您必须停用已废弃的密钥,以防止系统接受其凭据。

应用开发者可以通过您的门户停用应用的 API 密钥,如下所示:

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 在“密钥”部分中,点击密钥历史记录以显示已废弃的密钥列表。
  4. 将光标置于要停用的已废弃 API 密钥上,以显示操作菜单。
  5. 点击 展开图标 以展开操作菜单。
  6. 点击停用。
  7. 点击停用以确认操作。
    密钥的状态已更新为“已撤消”。

修改应用详细信息

应用开发者可以修改应用详情,如下所示:

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 修改“名称”或“说明”字段。
  4. 点击保存。

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

删除应用

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

  1. 从用户下拉菜单中选择我的应用。
  2. 点击该应用的名称。
  3. 点击页面右上角的删除。

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