授权请求(authorize)
OAuth2.0授权码模式需要使用"application/x-www-form-urlencoded”格式向授权服务请求授权。
网关地址
沙箱环境调用地址: | https://sandbox.hscloud.cn |
数据核查类生产调用地址: | https://api.hscloud.cn |
仿真业务接口生产调用地址: | https://vopen.hscloud.cn |
其余生产调用地址: | https://open.hscloud.cn |
URL
https://sandbox.hscloud.cn/oauth2/oauth2/authorize |
---|
是否需要业务登录
否 |
---|
HTTP请求方式
GET |
---|
请求参数
参数名 | 类型 | 必填 | 最大长度 | 默认值 | 中文名 | 描述 |
---|---|---|---|---|---|---|
response_type | String | 是 | 授权响应类型 |
授权码模式时,必须为code,隐式授权模式时,必须为token
|
||
state | String | 否 | 应用状态 |
用于防CSRF攻击,成功授权后在回调中原样返回
|
||
client_id | String | 是 | 应用标识 |
创建应用时获取的App Key
|
||
redirect_uri | String | 是 | 回调地址 |
应为创建应用时注册登记的回调地址,且需要将url进行URLEncode编码,编码格式为UTF-8
|
||
scope | String | 否 | 授权范围 |
用于指定授权访问的范围,多个授权范围可以使用逗号(,)连接
|
||
client_type | String | 否 | 应用类型 |
可以是PC或Mobile,分别表示应用类型为桌面终端或移动终端,默认为PC
|
返回参数
参数名 | 类型 | 最大长度 | 默认值 | 中文名 | 描述 |
---|---|---|---|---|---|
scope | String | 授权范围 |
用于授权服务器通知App应用颁发令牌的访问范围,多个授权范围可以使用逗号(,)连接。
|
||
token_type | String | 令牌类型 |
令牌类型告诉客户端一个信息,即当访问一个受保护资源时访问令牌应该如何被使用
|
||
state | String | 应用状态 |
如果state参数在应用授权请求中存在,则这个参数是必需的。
必须设置成从应用接收到的值。 |
||
expires_in | String | 访问令牌生命周期 |
表示访问令牌生命周期的秒数。
例如,“86400”表示自响应被授权服务器产生的时刻起,访问令牌将在24小时后过期;具体以实际返回值为准。 |
||
code | String | 授权码 |
表示由授权服务器产生用于应用向授权服务器交换令牌的授权码,授权码应该在颁发后迅速过期,以降低泄露风险;
客户端应用一定不能重用同一个授权码,如果一个授权码被多次使用,授权服务器可能撤销之前基于这个授权码分发的所有令牌。 授权码与客户端标识符和重定向URI相绑定。 |
||
access_token | String | 访问令牌 |
由授权服务器颁发的访问令牌
|
请求示例
GET /oauth2/oauth2/authorize?response_type=code&client_id= 186417ce-xxxx-xxxx-xxxx-xxxxx1b92003&state=xyz&redirect_uri=https%3A%2F%2Fclient %2Eexample%2Ecom%2Fcb HTTP/1.1 Host: api.hscloud.cn