tachybase_todo/packages/plugins/api-keys/docs/zh-CN/usage.md

20 lines
552 B
Markdown
Raw Normal View History

# API keys 使用方法
## 创建 API key
当你启用插件后,前往 API keys 的插件管理页面,点击 `添加 API key` 并填写相关信息,点击 `保存` 即可创建 API key。
## 使用 API key
在请求头中添加 `Authorization` 字段,值为 `Bearer ${API_KEY}`,即可使用 API key 访问 `NocoBase` 所有 API。
cURL 的例子如下
```bash
curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'
```
## 删除 API key
目前删除 API key 并不能使 Key 失效,请注意保管好你的 API key。