功能说明
API 鉴权是指在使用 API 时支持对用户进行身份验证和权限验证,是保证 API 安全性和稳定性的重要特性,数据服务平台支持通过 AppKey、AppSecret 作为调用凭证来进行身份验证,用于对 API 请求进行签名。
操作步骤
对查找到的 API 进行申请和调用,API 认证方式为“应用认证”时需要使用方发起申请。
1. 查找到 API 后,可单击 API 介绍 查看 API 文档。
![](https://qcloudimg.tencent-cloud.cn/image/document/85d82a39ac6e3562229fd4bbfdef7ec0.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/85d82a39ac6e3562229fd4bbfdef7ec0.png)
2. 单击 API 申请调用,分为应用认证与免认证两种认证方式。
2.1 方式一:对于“应用认证”的 API 申请方法如下:
2.1.1 单击所需数据服务下的申请调用。
![](https://qcloudimg.tencent-cloud.cn/image/document/5f39631e474840a974506d447a4faf5c.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/5f39631e474840a974506d447a4faf5c.png)
2.1.2 在页面中配置申请信息。
申请内容:确认申请的 API 详情、标签、服务提供方、认证方式是否合适。
申请信息:确认申请人,配置最大请求量、有限期、关联应用、申请理由。
![](https://qcloudimg.tencent-cloud.cn/image/document/7b4dcc57214ec2066a0c66a7bf0dd695.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/7b4dcc57214ec2066a0c66a7bf0dd695.png)
2.1.3 配置完成后,单击提交申请。对于“应用认证”的 API 当前 wedata 采用 API 网关自身的应用认证方式。
![](https://qcloudimg.tencent-cloud.cn/image/document/835630a9b92b54fce2cafed4b9b851a9.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/835630a9b92b54fce2cafed4b9b851a9.png)
2.1.4 申请凭证:申请人向 API 提供方发起申请后,经 API 提供方在我的应用 > 新建应用 > 应用完成配置后,获取 App 凭证信息(包括应用 ID、ApiAppKey 和 ApiAppSecret)。
计算签名,参考应用认证说明文档 API 网关使用签名密钥对请求内容进行签名计算。
发起调用,使用 API 签名发起调用,具体调用信息请参考 API 详情。
2.2 方式二:对于“免认证”则不需要申请,可直接调用。
![](https://qcloudimg.tencent-cloud.cn/image/document/50031d6abc08836dc7b0bcd979254893.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/50031d6abc08836dc7b0bcd979254893.png)
API 密钥
操作场景
用户创建密钥为 API 服务提供 AppKey、AppSecret 等调用凭证。
操作步骤
1. 单击左侧 服务调用 > 我的应用,单击 新建应用 配置好应用名称与描述信息,即可完成应用创建,自动生成 AppKey、AppSecret。
![](https://qcloudimg.tencent-cloud.cn/image/document/eae3788d04ff18a2dd2c6240356f534c.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/eae3788d04ff18a2dd2c6240356f534c.png)
2. 填写应用名称、应用描述。
![](https://qcloudimg.tencent-cloud.cn/image/document/e29247d655e31bd716854e504d6b031d.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/e29247d655e31bd716854e504d6b031d.png)
3. 应用列表。
在应用列表中展示已创建的应用信息,包括应用 ID、应用密钥、描述、创建时间、修改时间,提供查看可调用的 API 接口、更新应用、删除应用的操作功能。
参数说明:
参数 | 说明 |
应用ID/名称 | 应用的 ID 号与英文名称 |
应用密钥 | |
描述 | 应用的描述信息 |
创建时间 | 应用的创建时间 |
修改时间 | 应用配置的最后一次修改时间 |
可调用接口 | 点击查看应用下可以调用的API接口 ![]() |
更新 | 更新应用 AppSecret,应用调用的 API 将受到影响,请谨慎操作。 |
删除 | 删除选中的应用 |