设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

鉴权

典型场景

第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。

接口功能

支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。

注意事项

鉴权接口是调用其他API的前提,除了调用鉴权接口(Auth),其他接口调用都需要使用鉴权接口获取的accessToken。

如果多次获取accessToken,则之前的accessToken失效,后一次获取的accessToken才有效。请勿并发获取accessToken。

接口描述

1
def getAuthToken(self, clientInfo)

接口所属类

Authentication

参数说明

参数

必选/可选

类型

位置

描述

clientInfo

必选

ClientInfo

-

见下表ClientInfo的描述。

ClientInfo

参数

必选/可选

类型

位置

描述

platformIp

必选

String(256)

path

设置平台的IP。

platformPort

必选

String(256)

path

设置平台的端口,如“8743”

appId

必选

String(256)

body

访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。

secret

必选

String(256)

body

访问物联网平台的应用密钥,与appId对应,在物联网平台创建应用时由平台分配获得。

返回值

AuthOutDTO

参数

类型

描述

scope

String(256)

申请权限范围,即accessToken所能访问物联网平台资源的范围,参数值固定为default。

tokenType

String(256)

accessToken的类型,参数值固定为bearer。

expiresIn

Number(256)

平台生成并返回accessToken的有效时间,单位为秒。

accessToken

String(256)

鉴权参数,访问物联网平台API接口的凭证。

refreshToken

String(256)

鉴权参数,用来刷新accessToken,refreshToken的有效时间为“1”个月。

错误码

Http状态码

错误码

错误描述

说明

400

100247

Operation not allowed. The application has been frozen.

应用冻结。

处理建议:请检查应用是否因为欠费冻结。

400

102202

Required Parameter is null or empty.

必选参数为空。

处理建议:请检查请求参数中的必选参数是否已填写。

401

100208

AppId or secret is not right.

appId或secret错误。

处理建议:

  • 请检查appId和secret是否有误,是否新增字符或缺少字符。
  • 请检查请求路径中的IP地址是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

分享:

    相关文档

    相关产品