Jump to

• Request
• Response
• Examples

Refresh Applink Token

put

/documents/api/1.2/applinks/token

Refresh an expired access token.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• accessToken: string

  This element provides access to the resource and expires after 15 minutes.

• appLinkID: string

  This element uniquely identifies the resource.

• refreshToken: string

  This element enables you to request a new access token when the current access token expires. The refreshed token expires after 24 hours.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The response body includes the refreshed access token.

Body ()

Root Schema : ApplinkTokenResponse

Type: object

The response body includes a refreshed access token.

Show Source

• accessToken(optional): string
  This element provides access to the resource and expires after 15 minutes. You can refresh the access token any number of times within the time period defined by the refreshed token (24 hours).
• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• type(optional): string
  Item type applink.

{
    "description":"The response body includes a refreshed access token.",
    "properties":{
        "accessToken":{
            "type":"string",
            "description":"This element provides access to the resource and expires after 15 minutes. You can refresh the access token any number of times within the time period defined by the refreshed token (24 hours)."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>applink</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Example Response (application/json)

{
    "accessToken":"GYrSN5zuj0kOTE4k_60bKvdkxx2-ARA546A2T77GtEOgoPZPGgKk126OeCn1w-Ij",
    "type":"applink",
    "errorCode":"0"
}

400 Response

Request parameters are not formatted correctly.

Back to Top

Examples

The following example requests a new access token.

PUT .../applinks/token

Request Header

The request parameters for the Refresh Applink Token call are supplied in the header of the call rather than in a conventional request. For example, the header parameters are similar to the following ones:

AppLinkID: LFwi1u1E9vZC_3pQhK5C4qxigAC4o1eUuMnv3dZbo6_OiaZx-yte-xIrxWdDJCA_jEgfVHe1At-26KX-M9mi9BaI7B0UX3Gx-QufREHWcHakby0_V9n8_C1pT7P_CKYlSqFU0rudQ8Q81M67-3fLffMA==
AccessToken: _qVnD42Et8KwZrBUqveiqn1sw-RLpfZQdIPPi_fd17-gt60FP6-IuCApyLFw32EL
RefreshToken: ctOCKm4mtpayp__jUlQsfdFEd52vSn2Pd4QxOTcSZ1Wch0f9JP7EFSaXmDLKZdql

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "accessToken": "RgzsGZPf6EwPj7SNasFkNiOZ3J7nESOxL2YMkRXuJ_Hg_1elUdhaP7l2Y7MVY0L_",
    "errorCode": "0",
    "type": "applink"
}

Back to Top