REST API¶
你可以使用 REST API 与正在运行的 Rasa 服务器进行交互。可以使用 API 进行模型训练、发送消息、运行测试等。
寻找 API 端点？
查看 API 规范来获取所有可用的端点以及他们的请求和响应格式。
启用 REST API¶
默认情况下，运行 Rasa 服务器不会启动 API 端点。与对话机器人的交互可以通过暴露的 webhooks/<channel>/webhook 端点实现。
要启用 API 来同对话追踪器和其他对话机器人端点直接交互，请将 --enable-api 参数添加到命令中运行：
请主要，使用仅 NLU 模型启动服务器，并非所有可用端点都可以调用。一些端点将返回 409 状态码，应为需要经过训练的对话模型来处理请求。
警告
确保通过限制对服务器的访问（例如使用防火墙）或启用身份验证方法来保护你的服务器。请参阅安全注意事项。
默认情况下，REST 服务器作为单个进程运行。可以使用 SANIC_WORKERS 环境变量更改工作进程的数量。建议将工作进程的数量设置为可用的 CPU 核数（更多信息请参见 Sanic 文档）。这只能与 RedisLockStore 结合使用（请参见锁存储）。
警告
SocketIO 频道不支持多个工作进程。
安全注意事项¶
建议不要将 Rasa 服务器直接暴露给外部，而是通过例如 Nginx 来连接它。
其内置了两种身份验证方法：
基于令牌的身份验证¶
要使用纯文本令牌来保护服务器，请在启动服务器时在 --auth-token thisismysecret 参数中指定令牌。
你还可以使用环境变量 AUTH_TOKEN 来设置身份验证令牌：
安全最佳实践
我们建议你在将 Rasa 部署为 Docker 容器时使用环境变量来存储和共享敏感信息（例如令牌和机密），因为它们不会存储在你的 shell 历史记录中。
任何向服务器发送请求的客户端都必须将令牌作为查询参数进行传递，否则将拒绝请求。例如，要从服务器获取追踪器：
基于 JWT 的身份验证¶
要使用基于 JWT 的身份验证，请在服务器启动时在 --jwt-secret thisismysecret 参数中指定 JWT 密码：
你还可以使用环境变量 JWT_SECRET 来设置 JWT 密钥：
安全最佳实践
我们建议你在将 Rasa 部署为 Docker 容器时使用环境变量来存储和共享敏感信息（例如令牌和机密），因为它们不会存储在你的 shell 历史记录中。
如果要使用非对称算法签署 JWT 令牌，可以将 JWT 私钥指定给 --jwt-private-key CLI 参数。你必须将公钥传递给 --jwt-secret 参数，并将算法指定给 --jwt-method 参数：
rasa run \
--enable-api \
--jwt-secret <public_key> \
--jwt-private-key <private_key> \
--jwt-method RS512
你还可以使用环境变量来配置 JWT：
安全最佳实践
我们建议你在将 Rasa 部署为 Docker 容器时使用环境变量来存储和共享敏感信息（例如令牌和机密），因为它们不会存储在你的 shell 历史记录中。
客户端对服务器的请求需要在 Authorization 头中包含一个有效的 JWT 令牌，该令牌使用此密钥和 HS256 算法进行签名，例如：
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ"
"zdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIi"
"wiaWF0IjoxNTE2MjM5MDIyfQ.qdrr2_a7Sd80gmCWjnDomO"
"Gl8eZFVfKXA6jhncgRn-I"
令牌的有效负载必须包含 user 键下的对象，该对象又必须包含 username 和 role 属性。如下是 JWT 令牌的示例负载：
如果 role 为 admin，则所有端点都可以访问。如果 role 是 user，则只有当 sender_id 与有效负载的 username 属性匹配时，才能访问带有 sender_id 参数的端点。