Help Center/ IoT/ API Reference/ Northbound PHP SDK API Reference/ Service API List/ Secure Application Access/ Authentication
Updated on 2022-02-24 GMT+08:00
View PDF
Share

Authentication

Typical Scenario

This API is called by an NA for access authentication when the NA accesses open APIs of the IoT platform for the first time. After the authentication of the NA expires, the NA must call this API to perform authentication again so that the NA can continue to access open APIs of the IoT platform.

API Function

This API is used by an NA to get authenticated before accessing open APIs of the IoT platform for the first time.

Note

The authentication API is the prerequisite for calling other APIs. Except the authentication API itself, other APIs must use the accessToken obtained by the authentication API.

If the access token is obtained for multiple times, the previous access token is invalid and the last access token obtained is valid. Do not obtain the access token through concurrent attempts.

API Description

1
 
public function getAuthToken()

Class

Authentication

Parameter Description

The values of appId and secret are those of the members of Methods of the NorthApiClient Class when the methods in Methods of the ClientInfo Class are called.

Return Value

AuthOutDTO

Parameter

Description

$scope

Indicates the application permission scope, that is, the scope of IoT platform resources that can be accessed using the accessToken. This parameter has a fixed value of default.

$tokenType

Indicates the type of the accessToken. This parameter has a fixed value of bearer.

$expiresIn

Indicates the validity time for the IoT platform to generate and return the accessToken, in seconds.

$accessToken

Indicates the authentication parameter that is used to access APIs of the IoT platform.

$refreshToken

Indicates the authentication parameter that is used to update the accessToken. The validity period of this parameter is 1 month.

Error Code

HTTP Status Code

Error Code

Error Description

Remarks

400

100449

The device is freezed cant operate.

The user does not have the operation permission.

Recommended handling: Check whether the user corresponding to appId has the permission to call the API.

400

102202

Required Parameter is null or empty.

Mandatory fields cannot be left blank.

Recommended handling: Check whether the mandatory parameters in the request are set.

401

100208

AppId or secret is not right.

appId or secret is incorrect.

Recommended handling:

  • Check whether appId and secret are correct. Specifically, check for new or missing characters.
  • Check whether the IP address in the request path is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.