更新时间:2022-02-24 GMT+08:00

鉴权

典型场景

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

接口功能

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

注意事项

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

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

接口描述

1
public function getAuthToken()

接口所属类

Authentication

参数说明

appId和secret使用NorthApiClient类方法成员变量的Clientinfo类方法中的值。

返回值

AuthOutDTO

参数

描述

$scope

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

$tokenType

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

$expiresIn

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

$accessToken

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

$refreshToken

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

错误码

Http状态码

错误码

错误描述

说明

400

100449

The device is freezed cant operate.

用户无操作权限。

处理建议:请检查appId所对应用户是否有接口调用权限。

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.

服务器运行内部错误。

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