Edith API 密钥管理

使用 Unkey 管理 Edith 智能眼镜应用的 API 密钥。

环境配置

用户必须将 UNKEYROOTKEY 和 UNKEYAPIID 设置为环境变量。

• - UNKEYROOTKEY — 来自 Unkey 控制面板的根密钥（用于创建/撤销密钥）
• UNKEYAPIID — Edith 用于验证密钥的 Unkey API ID

工具

本技能使用 curl 调用 Unkey REST API。所有请求均发送至 https://api.unkey.dev。

命令

创建新 API 密钥

为插件开发者或设备创建密钥。可选择设置名称、过期时间或速率限制。

bash
curl -s -X POST https://api.unkey.dev/v1/keys.createKey \
-H Authorization: Bearer $UNKEYROOTKEY \
-H Content-Type: application/json \
-d {
apiId: $UNKEYAPIID,
name: {{name}},
prefix: edith,
meta: { purpose: {{purpose}} },
expires: {{expiresunixmsornull}},
ratelimit: {
async: true,
limit: {{ratelimitpersecondor_10}},
duration: 1000
}
}

响应包含 key（提供给用户）和 keyId（用于管理）。

列出所有密钥

bash
curl -s https://api.unkey.dev/v1/apis.listKeys?apiId=$UNKEYAPIID \
-H Authorization: Bearer $UNKEYROOTKEY

撤销密钥

通过 keyId 永久删除密钥。

bash
curl -s -X POST https://api.unkey.dev/v1/keys.deleteKey \
-H Authorization: Bearer $UNKEYROOTKEY \
-H Content-Type: application/json \
-d {keyId: {{keyId}}}

验证密钥（只读检查）

bash
curl -s -X POST https://api.unkey.dev/v1/keys.verifyKey \
-H Content-Type: application/json \
-d {apiId: $UNKEYAPIID, key: {{key}}}

更新密钥（重命名、更改速率限制、设置过期时间）

bash
curl -s -X POST https://api.unkey.dev/v1/keys.updateKey \
-H Authorization: Bearer $UNKEYROOTKEY \
-H Content-Type: application/json \
-d {
keyId: {{keyId}},
name: {{new_name}},
ratelimit: {
async: true,
limit: {{new_limit}},
duration: 1000
}
}

工作流程

当用户要求管理 Edith API 密钥时：

1. 1. 检查 UNKEYROOTKEY 和 UNKEYAPIID 是否已在环境中设置。
2. 如果创建密钥：询问名称/用途，创建密钥，并向用户显示密钥（仅显示一次）。
3. 如果列出密钥：获取并以表格形式显示 keyId、名称、创建时间和状态。
4. 如果撤销：与用户确认 keyId，然后删除。
5. 插件通过 ?linkCode=...&apiKey=... 连接到 Edith WebSocket 中继——当服务器上设置了 UNKEYAPIID 时，中继会自动通过 Unkey 验证密钥。

示例

用户：为我的演示插件创建一个 API 密钥

bash
curl -s -X POST https://api.unkey.dev/v1/keys.createKey \
-H Authorization: Bearer $UNKEYROOTKEY \
-H Content-Type: application/json \
-d {
apiId: $UNKEYAPIID,
name: demo-plugin,
prefix: edith,
meta: { purpose: demo plugin },
ratelimit: { async: true, limit: 10, duration: 1000 }
}