鉴权方式
所有业务接口都通过 header 传用户级 API Key:
X-KGP-Api-Key: <your_api_key>
如果你还没有 key,先到主站的 API Key 页面 激活并复制。
最先调用哪个接口
先调:
GET /me
它用于:
- 校验当前 key 是否有效
- 判断当前 key 是否具备创作能力
- 确认调用方拿到的是正确用户的 key
基本规则
/health不需要鉴权/catalog和/creations*需要用户级 API Key- 不建议跳过
/me直接发创建
服务端该怎么保存 Key
- 每个用户单独保存
- 不把 key 打进日志
- 不用共享 key 代理所有用户
- 出错时只展示前缀,不回显完整 key
常见错误处理
- key 无效:提示用户重新检查或重新激活
- key 权限不足:不要继续发创建
- 积分不足:把用户引导回主站处理
关于 Key 管理
公开 OpenAPI 不负责激活、重置或失效 key。
这些操作应由用户在主站通过账户头像菜单进入独立的 API Key 页面 完成。
