API Key鉴权机制
更新时间:2025-02-24
API Key简介
API Key是百度智能云全新推出的鉴权方式,主要面向以下两个目标:
- 跨产品调用服务。同一个API Key可同时调用AI开放能力(文字识别、人脸识别、语音技术等)、大模型服务与开发平台ModelBuilder、大模型应用开发平台AppBuilder的接口服务,降低您接入AI服务的成本。
- 简化调用步骤。API Key既可直接使用明文调用接口进行鉴权,也可以换成短期APIkey后再进行鉴权。 为了更高的安全性,减少API Key的明文泄露风险,建议您使用短期APIkey的鉴权方式。
API Key与AI开放能力原access_token鉴权方式的区别
区别 | API Key | 原access_token鉴权机制 |
---|---|---|
支持的产品范围 | ModelBuilder、AppBuilder、AI开放能力 | AI开放能力 |
是否支持客户端HTTP SDK | 暂不支持 | 支持 |
鉴权流程 | 创建API Key后,可直接使用API Key调用业务接口,也可以换取短期API Key调用业务接口 | 先创建应用,再获取应用的API Key(简称AK)和Secret Key(简称SK),用AK和SK换Access token,最后使用Access token调用业务接口 |
与应用的关系 | 创建API Key后,系统自动生成一个应用,用于后续查询调用量 | 先创建应用,再基于应用的AK和SK进行鉴权 |
调用量查询 | 支持 | 支持 |
使用流程
流程主要有以下三步:
- 创建API Key,并配置权限范围
- (可选)使用API Key换取 短期API Key
- 使用API Key明文或短期API Key,调用服务接口
创建API Key,配置权限范围
登录后,前往API Key管理页,点击『创建API Key』按钮,在『服务』里选择『AI开放能力』。
在下方的『接口选择』处,您可选择『全部接口』或『有限范围』。
- 选择『全部接口』,则本API Key可调用所有本机制支持的AI开放能力接口。支持范围见下方APIKey支持的接口范围
- 选择『有限范围』,则本API Key仅可调用勾选了的接口。
(可选)换取短期API Key
本步骤为可选操作。如您想快速完成接口调通,可以跳过本步骤。
基于安全性考虑,在生产环境中强烈建议您使用短期API Key进行接口调用,短期API Key的创建方法参考创建API Key(短期)。
调用服务接口
使用API Key调用服务接口时,在请求的Header头域中需要包含API Key的鉴权信息。
注意:填入鉴权信息时,需要在API Key或短期API Key前面加上 Bearer
请求头域参数 | 参数介绍 | 参数示例 |
---|---|---|
Authorization | API Key或短期API Key | Bearer bce-v3/ALTAK-DaIdq27UJ9Y2UEDIWx1EF/1c511d0576aee39sd59fd73983749109qq8ciq37 |
其他调用方式和字段未做改变,可直接参考各服务接口的接口文档。
新旧鉴权字段说明
请不要在请求参数里同时使用新旧两种鉴权字段。具体来说:
· 如您希望使用API Key鉴权,请不要再传入原鉴权方式的access_token字段。(原鉴权方式里,语音技术的access_token在body参数里,其他产品的access_token通常在url参数里)
· 同样地,如您希望使用原access_token鉴权方式,请不要在请求的Header头域中传入Authorization字段。
APIKey支持的接口范围
目前API Key仅支持调用公有云接口,暂不支持客户端HTTP SDK的鉴权。
产品方向 | 支持的接口范围 | 接口文档链接 |
---|---|---|
文字识别 | 全部公有云接口 | 接口文档 |
人脸识别 | 全部公有云接口(依赖人脸库建库的除外) | 接口文档 |
语音技术 | 全部公有云接口 | 接口文档 |
图像识别 | 全部公有云接口 | 接口文档 |
图像增强与特效 | 全部公有云接口 | 接口文档 |
人体分析 | 全部公有云接口 | 接口文档 |
自然语言处理 | 全部公有云接口 | 接口文档 |
机器翻译 | 全部公有云接口 | 接口文档 |
内容审核 | 全部公有云接口 | 接口文档 |
更多介绍
有关API Key的更多介绍,例如子用户如何使用API Key、API Key如何管理维护等,请参考API Key通用介绍。