Refresh

To make the customer's login process easier, the store may use an access token to keep the client logged in for a period of time. Access tokens, on the other hand, may only be valid for a short amount of time for security reasons. A refresh token is used to "refresh" the access token once it has expired. This endpoint refresh token allows a client to receive new access tokens without requiring them to log in again.

TIP

The refresh endpoint has been implemented in the Login Web Component, and It's all setup to save developer's time and effort.

Response

Success

Error

auth.refresh.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

Usage

The method refresh() can be called in order to generate a new access token for the customer. It does not require any input.

Events

This endpoint may trigger one event, which is the onRefreshFailed event.

onRefreshFailed

This event will be triggered when the access token refresh process is not completed, and an error has occurred.

Response#

Usage#

Events#

onRefreshFailed#

Response

Usage

Events

onRefreshFailed