Refresh tokenSignature required

2023-10-13 05:48

POST /amsin/api/v1/oauth/applyToken

Access tokens expires 30 days from they are granted. You can refresh or extend an access token by using the refreshToken API.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

refreshToken String REQUIRED

The refresh token that is returned by the applyToken API.

grantType String REQUIRED

The authorization grant type. Valid value:

REFRESH_TOKEN: indicates that the refresh token is used to obtain the access token.

Response parameters

result Result object REQUIRED

The result of the API call, including the result status, result code and result message.

Show child parameters

accessToken String REQUIRED

The access token.

Note: This parameter is returned on demand only when result.resultStatus = S.

expireTime DateTime REQUIRED

The expiration time of the access token.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

refreshToken String

The refresh token.

Note: This parameter is returned on demand only when result.resultStatus = S.

refreshTokenExpireTime DateTime

The expiration time of the refresh token.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

extendInfo String

The extended information.

Note: This parameter is returned on demand only when result.resultStatus = S.

API Explorer

Request

URL

Case

Result status is S/Success

Request Body

Response

Case

Result status is S/Success

Response Body

Result processing logic

After calling the API, WorldFirst returns a response. The responses for result.resultStatus are:

Result status	Description
S	This indicates the API call succeeded.
F	This indicates the API call failed. For more information on why the call failed, see result.resultCode.
U	This indicates the API call result is unknown. A partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries maximum. Intervals between queries: 5min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min. If none of the queries is successful, contact WorldFirst Technical Support.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do Not retry.	Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue.
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Check and verify whether the request fields (e.g., requestId), including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	The client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Ensure the HTTP method is `POST` and retry.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST` and retry.
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	The service might be down, retry later. If the issue persists, contact the WorldFirst Technical Support Team.
UN_SUPPORT_BUSINESS	F	Unsupported business.	Ensure that all the request parameters are correct and try to call the API again.
AUTHORIZATION_NOT_EXIST	F	The authorization does not exist.	Retry the authorization process. If the issue persists, contact the WorldFirst Technical Support Team.