Versions Compared

Key

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

Table of Contents

Table of Contents
stylenone

Changelogs

Version

Date

Changes by

Description of change

V1.0

April 10, 2024

Que Nguyen

  • Initiate document

Release status

Environment

Status

Released Date

Version

DEV

Status
colourGreen
titleReleased

April 10, 2024

V1.0

UAT

Status
colourGreen
titleRELEASED

April 17, 2024

V1.0

PROD

Status
colourBlue
titleNOT RELEASED

N/A

N/A

API Definitions

Get Access Token

GrantType

Resource information

Response format(s)

JSON

Requires authentication?

No

Request Header

Name

Value

Content-Type

application/json

Request Body

ApiKeyRefreshToken

  • required

  • string(36)

API key value associate with a User + Business Account

RefeshToken getting from the response

GrantType

  • required

  • string

refresh_token

ClientId

  • required

  • string(36)

System / App / Platform unique identifier

ClientSecret

  • required

  • string(36)

System / App / Platform secret

Returns

Returns a message with status code.

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

AccessToken

string

User access token

https://redex-eco.atlassian.net/wiki/spaces/PAD/pages/286490675/Authentication#Access-Token%3A

RefreshToken

string

User refresh token. Using in API “GET Refresh Token”

Token life time: https://redex-eco.atlassian.net/wiki/spaces/PAD/pages/286490675/Authentication#Refresh-Token%3A

ExpiresIn

int

Token’s expired time in second

TokenType

string

Type Identifier

Scope

string

Collection of scopes granted for this user access token

Request

Status
colourGreen
titlePOST
/public/v2/connect/token/refresh

Body

Code Block
languagejson
{
  "RefreshToken": "4d7869f0-71cc-43d8-8b82-1f87db6eda2f",
  "GrantType": "refresh_token",
  "ClientId": "3Yj1rQvcDGYXqXtaxDNyWaNkWPUAwJ",
  "ClientSecret": "fNDq3vGM26wzOqr9OMUXQkxdG5J3$o"
}

Response

Info

200 Success

Code Block
languagejson
{
  "Data": {
    "AccessToken": "{{accessToken}}",
    "RefreshToken": "{{refreshToken}}",
    "ExpiresIn": 3600,
    "TokenType": "Bearer",
    "Scope": "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"
}