基于安全认证AK和SK鉴权调用API教程
更新时间:2024-09-19
本文介绍了基于安全认证AK/SK(Access Key /Secret Key)鉴权方式,进行调用API的流程。以调用ERNIE-3.5-8K API为例说明。
步骤简介
基于安全认证AK/SK进行鉴权,步骤简介如下。
步骤一:API授权。
步骤二:获取安全认证Access Key(即AK)、Secret Key(即SK)。
步骤三:生成鉴权认证信息Authorization。
步骤四:调用API接口。
步骤一. API授权
千帆大模型开发平台ModelBuilder默认为应用开通部分API调用权限,无需申请授权。
注意:针对付费服务,如果用户未开通API权限,无法调用对应的API。如需开通,请在千帆ModelBuilder控制台-模型服务-模型推理页面,点击开通付费。
步骤二. 获取安全认证AK/SK
(1)登录百度智能云管理控制台,点击“用户账号->安全认证”进入Access Key管理界面。
(2)点击显示查看Access Key、Secret Key。关于AK/SK,更多介绍请参考获取AK/SK。
步骤三. 生成用于鉴权的认证字符串Authorization
本文使用签名计算工具计算签名为例说明。鉴权认证流程,更多介绍请参考鉴权认证机制。
(1)查看需调用的API文档
例如,希望调用ERNIE-3.5-8K,查看文档。如果调用其他API,详见API列表。
(2)打开签名计算工具
进入签名计算工具页面,如下图所示。
(3)填入签名需要的信息
例如,希望调用ERNIE-3.5-8K,在签名计算工具中,填入对应内容,示例如下:
- HTTP请求信息
签名内容 | 计算签名时是否必需 | 说明 |
---|---|---|
HTTP方法 | 必填 | · 示例值:POST · 请求方式,通过以下方法获取:在API调用文档页面-请求说明-基本信息查看,如下图所示: |
路径 | 必填 | · 示例值:/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions · API路径,通过以下方法获取:在API调用文档页面-请求说明-基本信息查看,如下图所示: |
参数 | 非必填 | 无 |
头域 | 必填 | · 固定值:aip.baidubce.com · API的域名,通过以下方法获取,如下图所示: |
- 签名信息
签名内容 | 计算签名时是否必需 | 说明 |
---|---|---|
Access Key | 必填 | · 示例值:ahudxxxxx · 注意:请使用实际值,即步骤二获取的AK |
Secret Key | 必填 | · 示例值:ahxxxxxwi4 · 注意:请使用实际值,即步骤二获取的SK |
时间戳 | 必填 | · 示例值:2024-04-17T11:46:25Z,使用页面的默认值即可 |
签名有效期(秒) | 必填 | · 示例值:1800 |
待签名头域(秒) | 非必填 | 注意:本文签名计算未使用x-bce-date,在签名工具中-签名信息,待签名头域里需去掉。 |
(4)点击一键计算。
(5)查看认证字符串结果
基于上述信息,使用签名算法计算认证信息Authorization,计算出的Authorization示例值为:
bce-auth-v1/ahudxxxxx/2024-04-17T11:50:59Z/1800/host/b074d1b4ff04018fd6c58ed7917e82d510e3e7669b483565037187e7be49b4a0
步骤四. 调用API
调用千帆ModelBuilder提供的相关接口,例如调用ERNIE-3.5-8K,示例如下。如需调用其他API,详见API列表。
# 用步骤三生成的鉴权的认证信息Authorization值,替换下列示例中“Authorization”值
curl -X POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions' \
--header 'Authorization: bce-auth-v1/ahudxxxxx/2024-04-17T11:50:59Z/1800/host/b074d1b4ff04018fd6c58ed7917e82d510e3e7669b483565037187e7be49b4a0' \
--header 'Content-Type: application/json' \
--data '{
"messages": [
{"role":"user","content":"你好"}
]
}'
调用结果如下: