跳到主要内容
版本:3.8.x

管理消费者凭据

消费者是使用 API 的应用程序。在服务上启用身份认证后,可以要求消费者在访问 API 前获取凭据,从而控制访问。

服务上启用的身份认证插件相当于 API 的锁,而消费者凭据则是开锁的钥匙。在 API7 企业版中,创建消费者需要唯一的用户名和至少一个凭据。

消费者可以使用多个不同类型的凭据,在身份认证时,这些凭据的地位相同。

备注

在实施基于消费者的凭据管理之前,请先考虑开发者是否是更合适的方案。

本教程介绍如何创建消费者并配置身份认证凭据。

前提条件​

  1. 安装 API7 企业版。
  2. 在网关组中运行一个 API。

配置 Key Authentication 凭据​

  1. 从侧边栏选择网关组的消费者。
  2. 点击 + 新增消费者。
  3. 在对话框中,执行以下操作:
  • 在名称字段中输入 Alice。
  • 点击新增。
  1. 在凭据选项卡下,点击 + 新增 Key Authentication 凭据。
  2. 在对话框中,执行以下操作:
  1. 再添加一个名为 backup-key 的 Key Authentication 凭据,Key 为 alice-backup-key。所有凭据都有效,可以互换用于 API 身份认证。

以下互动演示介绍如何使用 API7 企业版配置 Key Authentication 凭据。

验证​

参阅为 API 启用 Key Authentication,在服务级别启用 Key Auth 插件。

然后按照验证 Key Authentication的说明进行验证。

配置 Basic Authentication 凭据​

  1. 从侧边栏选择网关组的消费者。
  2. 点击 + 新增消费者。
  3. 在对话框中,执行以下操作:
  • 在名称字段中输入 Alice。
  • 点击新增。
  1. 在凭据选项卡下选择 Basic Authentication 选项卡,然后点击新增 Basic Authentication 凭据。
  2. 在对话框中,执行以下操作:
  1. 再添加一个名为 backup-basic 的 Basic Authentication 凭据,用户名为 alice-backup,密码为 alice-backup-password。所有凭据都有效,可以互换用于 API 身份认证。

验证​

参阅为 API 启用 Basic Authentication,在服务级别启用 Basic Auth 插件。

然后按照验证 Basic Authentication的说明进行验证。

配置不同类型的身份认证凭据​

消费者可以具有多个不同类型的凭据,但已发布服务中的每条路由只应配置一个身份认证插件。这样,消费者可以使用各自偏好的身份认证方式访问多条路由。

以下互动演示介绍如何使用 API7 企业版配置不同类型的身份认证凭据。

  1. 从侧边栏选择网关组的消费者。
  2. 点击 + 新增消费者。
  3. 在对话框中,执行以下操作:
  • 在名称字段中输入 John。
  • 点击新增。
  1. 在凭据选项卡下点击新增 Key Authentication 凭据。
  2. 在对话框中,执行以下操作:
  • 在名称字段中输入 key-auth。
  • 在 Key 字段中输入 john-key-auth。
  • 点击新增。
  1. 在凭据选项卡下选择 Basic Authentication,然后点击新增 Basic Authentication 凭据。
  2. 在对话框中,执行以下操作:
  • 在名称字段中输入 basic-auth。
  • 在用户名字段中输入 john。
  • 在密码字段中输入 john-password。
  • 点击新增。
  1. 在凭据选项卡下选择 JWT,然后点击新增 JWT 凭据。
  2. 在对话框中,执行以下操作:
  • 在名称字段中输入 jwt-auth。
  • 在 Key 字段中输入 john-jwt-key。
  • 在算法字段中选择 RS256。
  • 在公钥字段中输入你的公钥。
  • 点击新增。
  1. 在凭据选项卡下选择 HMAC Authentication,然后点击新增 HMAC Authentication 凭据。
  2. 在对话框中,执行以下操作:
  • 在名称字段中输入 hmac-auth。
  • 在 Key ID 字段中输入 john-key。
  • 在 Secret Key 字段中输入 john-hmac-key。
  • 点击新增。

相关阅读​