• 1. 开启 HTTP API
• 2. 安全考虑
  • 2.1 基于Token的身份验证
  • 2.2 基于JWT的身份验证

🚀 原文地址：https://rasa.com/docs/rasa/http-api

我们可以使用 HTTP API 与正在运行的 Rasa 进行交互，通过 API，我们可以训练模型，发送消息、运行测试等。

1. 开启 HTTP API

默认情况下，运行 Rasa 服务器不会启用 API 端点，与机器人的交互可以通过暴露的/webhooks/<channel>/webhook端点发生。

启用 API 之后，可以直接与对话跟踪器和其他机器人端点进行交互，需要将--enable-api参数添加命令中：

$ rasa run  --enable-api

请注意，如果仅仅使用 NLU 模型启用服务器，并非所有可用端点都可以调用。一些端点将返回 409 状态码，因为需要经过训练的对话模型来处理请求。

:::danger ⌛ 当心——————————确保通过限制对服务器的访问（例如使用防火墙）或启用身份验证方法来保护我们的服务器。 :::

默认情况下，HTTP 服务器作为单个进程运行。我们可以使用SANIC_WORKERS环境变量更改工作进程的数量。建议将workers数量设置为可用 CPU 核心的数量。

:::danger ⌛ 当心——————————SocketIO 通道并不支持多个worker进程。 :::

2. 安全考虑

我们建议不要将 Rasa 服务器暴露给外界，而是通过私有连接从后端连接到它，例如在两个 docker 容器中。

不过，内置了两种身份验证的方法：

• 基于Token的身份验证
• 基于JWT的身份验证

  2.1 基于Token的身份验证

  启用服务器时，使用--auth-token thisismysecret传入令牌：

  $ rasa run \
    -m models \
    --enable-api \
    --log-file out.log \
    --auth-token thisismysecret

我们的请求需要传递token参数，在上述例子中为thisismysecret：

$ curl -XGET localhost:5005/conversations/default/tracker?token=thisismysecret

2.2 基于JWT的身份验证

使用--jwt-secret thisismysecret开启基于 JWT 的身份验证，对服务器的请求需要包含一个有效的 JWT Token，并在Authorization请求头将密钥和 HS256 算法生成的字符串。

token 有效负载必须包含用户键下的对象，该对象又必须包含用户名和角色属性。如果role是admin，则所有端点都可以访问。如果role是user，则只有当sender_id与有效负载中的username属性匹配时，才能访问带有sender_id参数的端点。

$ rasa run \
    -m models \
    --enable-api \
    --log-file out.log \
    --jwt-secret thisismysecret

设置了正确 JWT 请求头如下：

"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ"
                 "zdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIi"
                 "wiaWF0IjoxNTE2MjM5MDIyfQ.qdrr2_a7Sd80gmCWjnDomO"
                 "Gl8eZFVfKXA6jhncgRn-I"

以下示例是 JWT token 的有效负载：

{
    "user": {
        "username": "<sender_id>",
        "role": "user"
    }
}

要创建和编码 token，我们可以使用 JWT 调试器等工具或 PyJWT 等 Python 模块。