Skip to main content

Get User Token

Brief Description

  • Get user token, need to specify the terminal type used when logging in.

Request Method

  • post

Request URL

  • {API_ADDRESS}/auth/get_user_token
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"platformID": 1,
"userID": "111111"
}
Field NameOptionalTypeDescription
platformIDRequiredintTerminal type when user logs in
userIDRequiredstringUser ID

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySUQiOiJvcGVuSU1BZG1pbiIsIlBsYXRmb3JtSUQiOjEsImV4cCI6MTY5Njc1NDgwNSwibmJmIjoxNjg4OTc4NTA1LCJpYXQiOjE2ODg5Nzg4MDV9.SAu86X3PzfYjtjBeYA4vZefNr1IiFKRgg12FeiXSm14",
"expireTimeSeconds": 7776000
}
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty on success
errDlterrDltDetailed error message, empty on success
dataobjectGeneral data object, see structure below
tokenstringObtained user token
expireTimeSecondsstringToken expiration time (in seconds)

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, see global error code document for details
errMsgstringBrief error message
errDlterrDltDetailed error message