API授权是指应用(APP)与API建立授权关系。应用(APP)是调用API时的身份,应用(APP)需要获得API的授权才能调用该API。
前提条件
API认证方式为 阿里云APP认证。
1 应用(APP)
应用(APP)是调用API的身份,每个APP默认有一对AppKey和AppSecret密钥对,AppKey需要在请求时作为参数在Header传入,AppSecret需要用于计算请求签名。详细摘要签名的计算传递方式,请查看文档使用摘要签名认证方式调用API。
AppKey和AppSecret密钥对,具备该APP的全部权限,需要妥善保管。如果发生泄露,您可以在API网关的控制台进行重置。
可以创建多个APP,根据业务需求分别授权给不同的API。注意,API的授权对象是APP而不是阿里云用户账号。
可以在API网关控制台完成对APP的创建、修改、删除、查看详情、密钥管理、查看已授权API等管理操作。
每个APP可以额外添加新的AppKey和AppSecret,具体可在APP详情页添加,新增的密钥对具备APP的所有权限且支持删除,默认的密钥对(创建APP时一起生成的)则无法删除。
创建应用(APP):
登录API网关控制台,左侧导航栏选择API调用>应用管理,然后单击右上角的创建APP。
在创建应用页面填写应用名称,单击创建。
在创建APP时,若有需要可以设置APP标签,自定义AK信息,配置拓展字段。
标签设置:通过标签(Tag)功能对APP进行标记。
自定义AK信息:允许用户在创建APP时自定义AK以及AppCode,同时允许用户修改已经在生产中的APP的AK以及AppCode,实时生效。
拓展字段:允许用户为APP配置一个扩展字段,并且将这个扩展字段作为系统参数传输给后端服务,系统参数名称为CaAppExtInfo。
重要2023年8月前购买的专享实例,如果拓展字段不生效需提交工单升级实例版本。
2 API授权
授权,是指授予某个APP调用某个API的权限。APP需要获得API的授权才能调用该API。
自己创建的APP,API可以直接授权。
云市场购买的API,用户有权操作已购买的API授权给自己的APP;如果没有APP,购买时云市场会为您创建一个APP,并且授权,具体请前往云市场的控制台查看。
如果想要使用合作伙伴(其他账号)提供的API,并无购买行为,是线下协议。那么需要自行创建APP,并且向API的提供者提供您的应用ID。API的提供者可以通过搜索应用ID来操作授权。
API授权:
2.1 登录API网关控制台,在左侧栏选择API 管理>API列表,然后选择API操作列下的>授权。
2.2 在授权页面选择要授权的环境,授权有效时间,选择要授权的应用。在我的应用,此时直接单击搜索,会自动加载本账号下的APP。
如果要给其他账号下APP授权,需要选择应用ID,然后在文本框中输入对应的应用ID,再单击搜索进行查询。
2023年11月之前购买的专享实例,若为APP额外添加了新的密钥对后不生效,需提交工单升级实例版本。默认的密钥对(创建APP时一起生成的)则不受版本影响。