Get Access Token¶

Get the access token using the access key and secret key of your application.

If the access token for your application is already generated, when you call the Get Access Token API again, the same access token will be returned if the access token has not expired.

Prerequisites¶

Register an application on EnOS Management Console to get the application’s access key and secret key, which are used as the values of the appKey and appSecret request parameters of the Get Access Token API.

Request Format¶

POST https://{apigw-address}/apim-token-service/v2.0/token/get

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
appKey	Mandatory	String	The access key of the application.
encryption	Mandatory	String	The encrypted ciphertext. See Encryption Generation Rule >>
timestamp	Mandatory	Long	The timestamp of the current system time (UNIX time, accurate to the millisecond), e.g. 1572574909697.

Encryption Generation Rule¶

Concatenate the values of appKey, timestamp, and appSecret to generate a string for encryption.
Encode the concatenated string in UTF-8 format and make a digest by SHA256 algorithm.
Convert the digest to hexadecimal format to generate the encrypted ciphertext. The sample code is as per the below.
```
sha256(appKey+timestamp+appSecret).toLowerCase();
```

Response Parameters¶

Name	Data Type	Descritpion
status	Integer	The API request status code, with 0 indicating a successful request.
msg	String	The explanation of the status code.
business	String	The business parameter, with the value apim-token-service.
data	Data Struct	The generated access token and its expiring time.

Data Struct¶

Name	Data Type	Description
accessToken	String	The value of the generated access token.
expire	Integer	The expiring time of the access token in seconds, with an initial value of 7,200 (i.e. 2 hours).

Sample¶

Request Sample¶

url: https://{apigw-address}/apim-token-service/v2.0/token/get
method: POST
requestBody:
{
    "appKey": "yourAppKey",
    "encryption": "87c6885cec7525e2f219f86a82b280cc8c2d6ff4040a4b5f8acf9aeeda37aba8",
    "timestamp": 1572574909697
}

Return Sample¶

{
    "stauts": 0,
    "msg": "SUCCESS",
    "business": "apim-token-service",
    "data": {
        "accessToken": "Generated_Access_Token",
        "expire": 7200
    }
}