一、应用场景
平台访问授权是物联云平台提供的一种,通过非用户身份进行资源访问和接口调用的服务。可以通过本服务提供AccessKey获取到平台资源的使用权限。AccessKey拥有的权限为企业成员能够拥有的最高级权限。
通过物联云平台提供的AccessKeyId和AccessKeySecret,可以换取到AccessToken。通过换取到的AccessToken即可调用平台内部的接口。
- 企业开发的应用,直接访问平台资源的情况下,可以直接使用AccessKey进行获取授权。
- 第三方平台需要访问物联云平台资源时,可以直接使用AccessKey进行获取授权。
二、功能说明
客户可以在物联网平台的管理台【系统设置->平台访问授权】中添加AccessKey授权。AccessKeyId和AccessKeySecret为一组授权信息。通过AccessKey换取AccessToken的情况下,需要同时提供一组信息。在平台查验通过后,会返回AccessToken。通过获取到的AccessToken访问平台资源以及接口的调用。
同一个时间一个AccessKey只能换取到一个有效的AccessToken。即通过同一个AccessKey进行换取AccessToken时,前一个换取到的AccessToken会自动失效。使用失效的AccessToken调用接口后,会返回403:AccessToken Invalid的错误。
注意:
- AccessToken在平台的默认有效期为10年,可以在平台手动禁用。
- 通过AccessKey进行访问,不会记录安全审计日志。
三、前提条件
需要在物联云平台创建AccessKey
程序使用的AccessKey在平台中为启用状态,并且创建时间不超过10年。
四、关键流程
4.1 创建Access Key ID、Access Key Secret
登录物联云平台管理台,在 系统设置->平台访问授权界面中,
点击“添加授权按钮”,输入授权名称,点击确定按钮。如图:系统会生成用于外部系统接入的授权AccessKeyID,点击查看按钮,即可查看对应的AccessKeySecret,
如图:
4.2 开发者换取平台访问授权调用凭证
流程说明:
- 首先,外部系统 开发者在企业管理台获取平台访问授权标识和秘钥。
- 其次,外部系统 开发者以平台访问授权标识和秘钥为参数向物联网中台发起 开发者换取平台访问授权调用凭证 请求。
- 最后,物联网中台接收到 开发者换取平台访问授权调用凭证 请求后进行一系列业务逻辑校验,为外部系统 开发者颁发平台访问授权级调用凭证。
五、API列表
5.1 平台访问授权调用凭证
5.1.1 开发者换取平台访问授权调用凭证
接口描述
第三方系统利用在企业管理台处获取平台访问的访问标识和访问秘钥,利用标识和秘钥请求物联网中台从而获得平台访问授权凭证。
请求方式
POST
请求地址
/v2/accesskey_auth
请求头
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
Content-Type | true | String | application/json |
请求参数
名称 | 位置 | 必填 | 类型 | 备注 |
---|---|---|---|---|
id | body | true | String | 平台访问授权标识 |
secret | body | true | String | 平台访问授权秘钥 |
请求示例:
{
"id":"4561321655663",
"secret":"1234654fds464fsd4f"
}
返回参数说明
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
access_token | true | String | 调用凭证 |
返回示例:
{
"access_token": "32112456326sdfsdfewfdsafdsads3sf"
}
错误码:
错误码 | 描述 |
---|---|
4001001 | 请求数据字段验证不通过 |
4001002 | 请求数据必须字段不可为空 |
4031001 | 调用凭证权限被禁止访问 |
4031003 | 无效的调用凭证 |
4031002 | 需要调用凭证 |
4041001 | 接口不存在 |
5031001 | 系统错误 |
4031024 | 权限不足 |
4031023 | 权限不足 |
4041024 | 平台访问授权不存在 |
4001071 | 平台访问授权被禁用 |
4001072 | 平台访问授权秘钥错误 |