跳到主要内容
版本:3.2.14.4

管理消费者的访问凭证

消费者是指使用你的API的应用程序或开发者。在你的 API 中的路由上启用身份验证可以让你控制访问,要求消费者在访问路由之前获得凭证。

消费者通常在 API 发布后创建。在 API7 网关中,创建消费者需要一个唯一的用户名并配置一个认证插件。

本教程将指导你创建消费者并配置密钥认证。

前提条件

  1. 安装 API7 企业版
  2. 在网关组上有一个运行的 API

添加消费者

  1. 从侧边栏选择网关组的消费者
  2. 点击 新增消费者
  3. 在对话框中,执行以下操作:
  • 名称 填写 Alice
  • 点击 新增

为消费者启用密钥认证

  1. 从侧边栏选择网关组的消费者
  2. 选择你的消费者,例如,Alice
  3. 插件字段中,搜索 key-auth 插件。
  4. 点击加号图标 (+)。
  5. 在对话框中,执行以下操作:
  • 将以下配置添加到JSON 编辑器

      {
    "key": "secret-key"
    }
  • 点击 启用

验证

请按照以下步骤验证密钥认证。

发送不带密钥的请求

发送不带 apikey 头的请求:

curl -i "http://127.0.0.1:9080/ip"  

由于未提供密钥,你将收到一个 HTTP/1.1 401 Unauthorized 响应,其请求正文如下:

{"message":"Missing API key found in request"}

发送带有错误密钥的请求

发送带有错误密钥的 apikey 头的请求:

curl -i "http://127.0.0.1:9080/ip" -H "apikey: wrong-key" 

由于密钥错误,你会收到一个 HTTP/1.1 401 Unauthorized 响应,其请求正文如下:

{"message": "Unauthorized"}

```text
{"message":"Invalid API key in request"}

发送带有正确密钥的请求

发送带有正确密钥的 apikey 头的请求:

curl -i "http://127.0.0.1:9080/ip" -H "apikey: secret-key" 

使用正确的密钥发送请求,你将收到一个 HTTP/1.1 200 OK 响应,其请求正文类似:

{
"origin": "192.168.0.102, 35.259.159.12"
}

相关阅读