Skip to content

Commit 968c9a7

Browse files
feat: 添加 api 调用示例
1 parent 1c66fac commit 968c9a7

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

docs/faq/other.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,23 @@
1616

1717
如需了解 SQLBot 自身的 API 调用方式,可通过浏览器开发者工具查看其网络请求。目前系统尚未提供基于 API Key 的认证方式,但支持通过 Token 进行接口调用。用户可在登录过程中获取 Token,相应的获取接口可在登录时观察请求获得。
1818

19-
完整的 API 接口列表可在 SQLBot 访问地址后追加 /docs进行查看,例如:https://your-sqlbot-domain/docs。
19+
完整的 API 接口列表可在 SQLBot 访问地址后追加 /docs进行查看,例如:https://your-sqlbot-domain/docs。
20+
21+
## 3 如何使用 SQLBot 的 API?
22+
23+
!!! Abstract ""
24+
SQLBot v1.5.0 版本开始正式支持了 API 的调用。可以在 API Key 页面获取对应的 Access Key 和 Secret Key。如下图所示:
25+
![api_key](../img/faq/api_key.png)
26+
27+
生成 JWT Token。Token 的生成过程是标准化的,这里拿在线工具(https://www.bejson.com/jwt/)举例。其中 header 参考下图,Payload 中填入 SQLBot 的 Access Key,对称密钥填写 SQLBot 的 Secret Key。 点击编码按钮,生成对应的 Token。如下图所示:
28+
![api_jwt](../img/faq/api_jwt.png)
29+
30+
生成 token 后,可以通过 API 调用工具来使用该 token 调用对应的接口。这里用在线工具(https://getman.cn/)举例。将生成的 token 复制下来,在请求的 header 里输入:
31+
```
32+
# 下面的 xxx 为 token
33+
x-sqlbot-ask-token: sk xxx
34+
```
35+
在 URL 里输入需要调用的 API 接口地址,如下图所示:
36+
![api_call](../img/faq/api_call.png)
37+
38+

docs/img/faq/api_call.png

152 KB
Loading

docs/img/faq/api_jwt.png

106 KB
Loading

docs/img/faq/api_key.png

199 KB
Loading

0 commit comments

Comments
 (0)