Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get Access Token

Get Access Token

grant_typeclient_secret

Resource information

Response format(s)

JSON

Requires authentication?

No

Request Header

Name

Value

Content-Type

application/www-form-urlencodedjson

Request Body

api_keyApiKey

string

Associate API key value associate with an userUser + BussinessAccount

Business Account

GrantType

string

api_key

client_idClientId

string

System / App / Platform unique identifier

ClientSecret

string

System / App / Platform secret

Returns

Returns a message with status code.

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

access_tokenAccessToken

string

User access token

expires_inExpiresIn

int

Token’s expired time in second

token_typeTokenType

string

Type Identifier

scopeScope

string

Collection of scopes granted for this user access token

Request

Status
colourGreen
titlePOST
/public/v2/connect/token

Body

Code Block
languagejson
{
  "api_keyApiKey": "4d7869f0-71cc-43d8-8b82-1f87db6eda2f",
  "grant_typeGrantType": "api_key",
  "client_idClientId": "3Yj1rQvcDGYXqXtaxDNyWaNkWPUAwJ",
  "client_secretClientSecret": "fNDq3vGM26wzOqr9OMUXQkxdG5J3$o"
}

Response

Info

200 Success

Code Block
languagejson
{
  "Data": {
    "access_tokenAccessToken": {{accessToken}},
    "expires_inExpiresIn": 3600,
    "token_typeTokenType": "Bearer",
    "scopeScope": "REDEX_api"
  }
  "StatusCode": 200,
  "Errors": null,
  "Meta": null,
  "Message": "Success"
}

Warning

401 Unauthorized

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 401,
  "Errors": {},
  "Meta": null
  "Message": "Unauthorized"
}