蓝心九问

鉴权

API 鉴权概述

为保障您的 API 调用安全,我们采用了基于单一密钥(API Key)的鉴权机制。所有发往 API 接口的请求都需要携带这个密钥,以验证您的身份和权限。这个密钥是一串唯一的代码内容,代表了您的应用身份和调用权限。

您在创建密钥后,请务必妥善保管好它,一旦泄露,可能导致您的 API 被非法调用。

使用方式

在发起 API 请求时,您需要将这串密钥嵌入到请求的 Header 中,以完成身份验证。以下是详细的使用步骤:

1. 获取密钥

在您要发布为 API 的 Bot 设置页面,点击 “API” 发布渠道。您可以在页面右侧的 “API 密钥” 部分找到已生成的密钥,或者点击 “创建密钥” 来生成新的密钥。

2. 添加鉴权 Header

在您的代码中,将密钥添加到请求的 HTTP Header 中。请使用 Authorization 字段,格式为:

Authorization: Bearer <您的密钥>

示例:

--header 'Authorization: Bearer {{API-SECRET-KEY}}'

a04-4286f6b77470149906b078761a673c2b.jpg

3. 发送请求

现在,您可以像平常一样发送 API 请求,但在请求中包含了上述鉴权信息。

示例(以 curl 为例):

curl --location --request POST 'https://\[九问host\]/chat-messages' \\\--header 'Authorization: Bearer {{API-SECRET-KEY}}' \\\--header 'Content-Type: application/json' \\\--data-raw '{"inputs": {},"query": "eh","response\_mode": "blocking","conversation\_id": "12276456","user": "abc-123","upload\_mediums": \[{"url":"http://ads-marketing-vivofs.vivo.com.cn/NtBrJ9dueygDLoz8/ad/img/20250313/d27c21ad3cff48c78f7b3c8b08b9e40b.jpg","type":"image"}\]}'

通过以上步骤,您的 API 请求将被平台正确识别和验证,确保只有获得授权的应用才能访问您的 Bot 服务。

On this page