API权限定义

API服务接口中,配置operation的时候,需要选择operation需要的权限:

这里的权限我们称为授权列表,指的是客户端需要申请什么样的权限才能调用这个服务接口,客户端的访问令牌如果不满足这里需要的授权列表,请求将被网关拦截。

这里的权限数据需要在API权限定义菜单下先定义。

定义权限

API管理>我的API>选中一个API>权限定义菜单下,选择创建权限:

创建权限需要如下两个属性:

属性 示例 说明
权限名 查询用户 用于显示的权限名称
权限编码 query_user 用于程序处理的权限代码,同一个API中不允许重复

创建完成后就可以在权限列表中看到这个权限了。

现在可以在服务接口中设置查询用户需要的权限:

设置权限完成后,客户端在服务目录中看到的服务接口就会看到需要这个权限了:

权限申请

定义了某个operation的调用需要的权限之后,客户端在调用这个API的时候,就需要先跟API提供商申请这个权限。

客户端在服务目录中看到某个API之后,如果需要申请使用这个API,需要在服务目录的API首页中点击申请使用进行权限申请:

按照指引给自己的客户端应用申请对应API的权限即可。

上一篇:API服务文档 下一篇:API开发