API 密钥
Qamaq API 使用 API 密钥认证请求。API 密钥与您的组织关联，可以具有不同的权限范围来控制允许执行的操作。
请妥善保管您的 API 密钥
切勿在公共仓库、客户端代码或其他公开可访问的位置分享您的 API 密钥。请像对待密码一样保护它们。
创建 API 密钥
要创建 API 密钥：
- 1登录您的 Qamaq 仪表板
- 2导航至「配置 > API 密钥」
- 3点击「创建新 API 密钥」
- 4为密钥命名并选择适当的权限范围
- 5复制并安全存储您的 API 密钥——密钥不会再次显示
使用 API 密钥
在 Authorization 请求头中使用 Bearer 方案携带您的 API 密钥：
cURL
curl -X GET "https://api.qamaq.io/api/v1/me" \
-H "Authorization: Bearer qmq_your_api_key"JavaScript
const response = await fetch('https://api.qamaq.io/api/v1/me', {
method: 'GET',
headers: {
'Authorization': 'Bearer qmq_your_api_key'
}
});
const data = await response.json();Python
import requests
response = requests.get(
'https://api.qamaq.io/api/v1/me',
headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()API 密钥权限范围
API 密钥可以具有不同的权限范围来控制可访问的资源：
| Scope | Description |
|---|---|
entities:read | 读取实体模式和记录 |
entities:write | 创建和修改实体记录 |
knowledge:read | 读取知识库中的文件夹和文件 |
knowledge:write | 创建和修改文件夹和文件 |
boards:read | 读取看板和工单 |
boards:write | 创建和修改看板和工单 |
认证错误
如果认证失败，您将收到以下错误响应之一：
401Unauthorized
未提供 API 密钥或密钥格式无效。
403Forbidden
API 密钥有效但对请求的资源或操作没有权限。
最佳实践
- 使用环境变量存储 API 密钥，切勿硬编码
- 为不同应用或环境创建单独的 API 密钥
- 为每个 API 密钥使用最小所需权限范围
- 定期轮换 API 密钥以提高安全性
- 在仪表板中监控 API 密钥使用情况
- 立即撤销任何可能已泄露的 API 密钥