操作场景
应用(App)是调用 API 的身份,应用(App)需要获得 API 的授权之后、才能调用该 API。每个应用(App)有一对 ApiAppKey 和 ApiAppSecret 密钥对,ApiAppKey 需要在请求时作为参数在 Header 传入,ApiAppSecret 需要用于计算请求签名。详细签名的计算方式请参见 应用认证方式。
前提条件
API 的前端配置中的鉴权类型为"应用认证"。
操作步骤
创建应用
1. 登录 API 网关控制台,在左侧导航栏调用 API 单击调用凭证 > 应用,进入应用管理页面。
2. 在应用管理页面,单击左上角的新建,填写表单后提交即可完成应用的创建。
API 授权
API授权,是指授予某个应用(App) 调用某个 API 的权限。应用(App)需要获得 API 的授权才能调用该 API,授权又分为两种方式:
授权方式 | 适用场景 | 操作说明 |
直接授权 | 自己创建的应用(App) | 参考下方直接授权 |
合作伙伴授权 | 使用合作伙伴(其他账号)提供的 API | 自行创建 应用(App),然后把您的应用 ID告知 API 的提供者。API 的提供者可以通过搜索应用 ID 来完成授权。 |
您可以单击以下页签,查看对应授权方式的操作步骤。
1. 登录 API 网关控制台,在左侧导航栏单击服务。
2. 在服务列表中,单击服务名,查看该服务详情。
3. 在服务信息中,单击管理 API 标签页,选择一个鉴权类型为应用认证的 API,右侧可见页签授权信息,在该菜单下单击新增授权,即可开始授权。(此处注意,如果前端鉴权类型不是应用认证,此处不会出现该页签)
4. 选择要授权的环境,和要授权的应用。左侧为我的应用,此时直接单击搜索,会自动加载本账号下的 App。
1. 登录 API 网关控制台 ,在左侧导航栏单击服务。
2. 在服务列表中,单击服务名,查看该服务详情。
3. 在服务信息中,单击管理 API 标签页,选择一个鉴权类型为应用认证的API,右侧可见页签授权信息,在该菜单下点击新增授权,即可开始授权。(此处注意,如果前端鉴权类型不是应用认证,此处不会出现该页签)
4. 如果要给其他账号下的应用(App) 授权,先请对方提供应用 ID。
5. 单击新增授权,选择授权环境、将筛选项切换为应用 ID、然后在输入框中填写第4步中的应用 ID,再单击搜索进行查询,单击提交即可。
注意事项
AppKey 和 AppSecret 密钥对,具备该应用(App)的全部权限,需要妥善保管。如果发生泄露,您可以在 API 网关的控制台进行重置。
可以创建多个应用(App),根据业务需求分别授权给不同的 API。
可以在 API 网关控制台完成对应用(App)的创建、修改、删除、查看详情、密钥管理、查看已授权 API 等管理操作。