mirrors/nocobase
1
0
Fork 0
mirror of https://github.com/nocobase/nocobase synced 2024-11-15 21:37:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
aab3fafd9b
nocobase/packages/plugins/api-keys/docs/zh-CN/usage.md
Dunqing 817646d68d
feat(api-keys): the expiration field support custom option (#2186) 
* feat(api-keys): the expiration field support custom option

* feat: support never option

* feat: support if expiresIn = never the expiresIn will replace to 1000y

* fix: toggle datepicker

* feat: update syntax

* fix: option order

* docs: update

* fix: maskCloseable should be false

* refactor: performance and remove unused code

* feat: should not allow clear

* fix: decode maybe fail

* fix: i18n
2023-07-06 16:33:28 +08:00

523 B
Raw Blame History

API keys 使用方法

创建 API key

当你启用插件后，前往 API keys 的插件管理页面，点击 添加 API key 并填写相关信息，点击 保存 即可创建 API key。

使用 API key

在请求头中添加 Authorization 字段，值为 Bearer ${API_KEY}，即可使用 API key 访问 NocoBase 所有 API。

cURL 的例子如下

curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'

删除 API key

删除 API key 后，该 Key 将无法继续使用。