Skip to main content
Version: v1.0

Obtain Access Token

Obtaining an accessToken for MAVI-API requests is essential. This API also provides a refreshToken to obtain a new accessToken if the current one expires. The default expiration time for accessToken is 4 hours. Both accessToken and refreshToken will be sent through callback URI provided in the request.

Host URL

Endpoint

POST auth/api/token/getAccessToken

  • Rate limit: 50 requests per day.
    • accessToken: Valid for 2 hours, used for API authentication.
    • refreshToken: Valid for 2 months, used to renew the accessToken.

Request Body            

{
"clientId": "myxjDRvjN+osYha2DxNAuVlYVnpY26BU2pPJdCyVzJU=",
"code": "xxxxxx"
}

Request Parameters            

NameLocationTypeRequiredDescription
bodybodyobjectNoRequest payload
» clientIdbodystringYesClient ID
» codebodystringYesCallback code

Response Example            

Status code 200 OK

{
"code": "string",
"msg": "string",
"data": {
"accessToken": "string",
"type": "string",
"expiresIn": 0,
"refreshToken": "string",
"refreshExpiresIn": 0
}
}

Response Structure            

NameTypeRequiredDescription
codestringYesStatus code
msgstringYesMessage
dataobjectYesData object
» accessTokenstringYesAccess token
» typestringYesToken type
» expiresInintegerYesToken expiration time
» refreshTokenstringYesRefresh token
» refreshExpiresInintegerYesRefresh token expiration time