作者:管理员 历史版本:1 最后编辑:龚清 更新时间:2025-01-02 11:51
审核接口授权
简述:
- 审核接口授权
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/audit
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | string | 是 | 主键 | ||
apiUrl | string | 是 | apiUrl | ||
grantType | string | 是 | 授权类型 | ||
grantKey | string | 是 | 授权标识 | ||
appKey | string | 是 | APP标识 | ||
apiKey | string | 是 | API标识 | ||
limit | long | 是 | 频次,非负整数,0标识不限制 | ||
testLimit | long | 否 | 测试频次,非负整数,0标识不限制; | ||
status | string | 否 | 状态:pendding/effect/expired | ||
createBy | string | 是 | 创建人 | ||
createTime | date | 是 | 申请时间 | ||
expireTime | date | 否 | 过期时间 | ||
auditBy | string | 否 | 审核人 | ||
auditTime | date | 否 | 审核时间 | ||
cause | string | 否 | 理由 |
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
批量审核接口授权
简述:
- 批量审核接口授权
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/audit/batch
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
authApiGrantIds | string[] | 是 | 审核接口授权id数组 | ||
cause | string | 否 | 审核不通过 | 不通过原因 | |
nopass | string | 否 | 不通过标识 |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
查询生效的接口授权
简述:
- 根据传入授权类型及授权标识查询,并返回生效的接口授权信息
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/findByGrantTypeGrantKey
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
grantKey | String | 是 | 接口授权标识 | ||
grantType | String | 是 | 接口授权类型 |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | List< AuthApiGrantPo > | API授权对象信息列表 |
查询
简述:
- 根据传入id查询,并返回接口授权信息
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/get
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
authApiGrantId | String | 是 | 接口授权id |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | AuthApiGrantPo | API授权对象信息 |
申请接口授权
简述:
- 申请接口授权
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/grant/save
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
apiArrayStr | string | 是 | 授权接口 | ||
grantKey | string | 是 | 授权标识 | ||
grantType | string | 是 | 授权类型 |
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
判断接口是否匿名访问
简述:
- 根据传入接口地址,判断是否存在接口授权匿名
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/has/anonymous/api/grant
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
uri | String | 是 | 接口地址 |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Boolean |
判断接口授权
简述:
- 根据传入接口地址,判断是否存在接口授权。应用接入标识、用户账号至少必填一个参数.
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/has/api/grant
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- GET
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
account | String | 否 | 用户账号 | ||
clientId | String | 否 | 应用接入标识 | ||
uri | String | 是 | 接口地址 |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Boolean |
记录接口调用
简述:
- 根据传入接口地址,记录接口调用情况。应用接入标识、用户账号至少必填一个参数.
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/log/apiInvoke
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
fullName | string | 否 | fullName | ||
id | string | 是 | 主键 | ||
uri | string | 是 | 请求地址 | ||
clientKey | string | 是 | 授权标识 | ||
account | string | 是 | 用户账号 | ||
status | string | 是 | 状态:Y/N | ||
createTime | date | 是 | 调用时间时间 | ||
cause | string | 否 | 理由 |
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
接口授权列表数据
简述:
- 接口授权列表数据
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/query
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | APIPageList< AuthApiGrantPo > | API授权对象信息列表 |
删除(批量)
简述:
- 删除接口授权记录
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/remove
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
authApiGrantIds | string[] | 是 | 接口授权id数组 |
- Body:
暂无
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
保存
简述:
- 保存接口授权信息
请求URL:
- http://ip:port/ibps/platform/v3/auth/api/grant/save
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式:
- POST
请求参数:
- Headers:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
X-Authorization-access_token | String | 是 | 系统令牌 |
- Query:
暂无
- Body:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | string | 是 | 主键 | ||
apiUrl | string | 是 | apiUrl | ||
grantType | string | 是 | 授权类型 | ||
grantKey | string | 是 | 授权标识 | ||
appKey | string | 是 | APP标识 | ||
apiKey | string | 是 | API标识 | ||
limit | long | 是 | 频次,非负整数,0标识不限制 | ||
testLimit | long | 否 | 测试频次,非负整数,0标识不限制; | ||
status | string | 否 | 状态:pendding/effect/expired | ||
createBy | string | 是 | 创建人 | ||
createTime | date | 是 | 申请时间 | ||
expireTime | date | 否 | 过期时间 | ||
auditBy | string | 否 | 审核人 | ||
auditTime | date | 否 | 审核时间 | ||
cause | string | 否 | 理由 |
请求参数示例:
返回示例:
返回参数说明:
名称 | 类型 | 备注 |
---|---|---|
data | Void |
备注
- [1] : APIRequest为动态查询请求对象,详情请移步全局请求格式