Versions Compared

Old Version 8

changes.mady.by.user Que Nguyen

Saved on

compared with

New Version 9

changes.mady.by.user Que Nguyen

Saved on

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

The Token

Resource information

Response format(s)

JSON

Requires authentication?

No

Request Header

Name

Value

Content-Type

application/json

Request Body

RefreshToken

  • required

  • string(36)

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

resource

The primary resource that you will be interacting with when retrieving the authorization token.

AccessToken text

User access token

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

RefreshToken text

string

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

Token

life time

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

ExpiresIn

string

int

Token’s expired time in second

TokenType

string

text

Type Identifier: Bearer

Scope

text

Collection of scopes granted for this user access token

Request

.

Code Block
languagejson
{
  "AccessToken": "{{AccessToken}}",
  "RefreshToken": "{{RefreshToken}}",
  "ExpiresIn": "3600",
  "TokenType": "Bearer",
  "Scope": "REConnect_api REDEX_api REHash_api"
}

API Definitions

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

Body

Code Block
languagejson
{

Request Header

Content-Type

application/json

Request Payload

RefreshToken (required) text

RefeshToken getting from the response

GrantType (required) text

Grant type: refresh_token

ClientId (required) text

System / App / Platform unique identifier

Max length: 36

ClientSecret (required) text

System / App / Platform secret

Max length: 36

Code Block
curl -X POST 'https://uat-api.redex.eco/public/v2/connect/token/refresh' \
-H 'Content-Type: application/json' \
-D '{
    "RefreshToken": "4d7869f0-71cc-43d8-8b82-1f87db6eda2f",
    "GrantType": "refresh_token",
    "ClientId": "3Yj1rQvcDGYXqXtaxDNyWaNkWPUAwJ",
    "ClientSecret": "fNDq3vGM26wzOqr9OMUXQkxdG5J3$o"
}'

Response

Response Body

Data object

Return Token Resource above

返回上面的Token资源

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta null object

Return null object

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info

200 Success

Code Block
languagejson
{
    "Data": {
        "AccessToken": "{{accessTokenAccessToken}}",
        "RefreshToken": "{{refreshTokenRefreshToken}}",
        "ExpiresIn": "3600",
        "TokenType": "Bearer",
        "Scope": "REConnect_api REDEX_api REHash_api"
    },
    "StatusCodeErrors": 200null,
    "ErrorsStatusCode": null200,
    "MetaMessage": null,"Return tokens successfully",
    "MessageMeta": "Success"null
}

Warning

401 Unauthorized

Code Block
languagejson
{
    "Data": null,
    "Errors": [
        {
            "StatusCodeKey": 401"unsupported_grant_type",
  "Errors": {},          "Message": "unsupported_grant_type"
        }
    ],
    "MetaStatusCode": 401,
 null   "Message": "unsupported_grant_type",
    "UnauthorizedMeta": null
}