# API 密钥管理
访问 SSRAG REST API 接口需要通过 API 密钥完成,该密钥是一串字符串,我们可以在 API 密钥管理 界面中对密钥进行管理,设置此密钥的访问权限、替换或让此密钥失效。
点击 系统管理 -> 管理员管理 -> API密钥管理,进入 API 密钥管理界面:

# 添加/编辑密钥
点击界面底部的 添加新密钥 按钮,或者点击列表右侧的 编辑 按钮,系统将弹出添加/编辑 API 密钥界面:

- 名称:
API 密钥的显示名称。
- 关联管理员:
API 密钥必须与一个管理员相关联,API 密钥的访问权限将被限制在此管理员的权限范围内。
- 授权范围:
授权范围定义 API 密钥可访问的 API 地址,API 密钥能够访问的 API 地址将被限制在授权范围内。
# 授权范围
- Channels:Channels 栏目 API,包含:
- Contents:Contents 内容 API,包含:
- Administrators:Administrators 管理员 API,包含:
- Users:Users 用户 API,包含:
- STL:STL 模板语言 API,包含:
# 获取密钥
点击列表右侧的 获取密钥 按钮,系统将弹出获取密钥界面:

我们可以在界面将 API 密钥 拷贝出来。
# 重设密钥
由于 API 密钥属于敏感信息,为了安全起见,建议定制重设密钥。在获取密钥窗口点击 重 设 按钮,系统将重设密钥:

# 删除密钥
点击列表右侧的 删除 按钮,系统将弹出确认窗口:

再次点击 删除 按钮,系统将彻底删除指定的 API 密钥。