機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

Applinkトークン・リフレッシュ

put

/documents/api/1.2/applinks/token

期限切れのアクセス・トークンをリフレッシュします。

リクエスト

サポートされるメディア・タイプ

• application/json
• application/xml

ヘッダー・パラメータ

• accessToken: string

  この要素は、リソースへのアクセス権を提供し、15分後に失効します。

• appLinkID: string

  この要素は、リソースを一意に識別します。

• refreshToken: string

  この要素では、現在のアクセス・トークンが失効したときに、新しいアクセス・トークンをリクエストできます。 リフレッシュされたトークンは24時間後に失効します。

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

レスポンス本文には、リフレッシュしたアクセス・トークンが含まれます。

本文 ()

ルート・スキーマ: ApplinkTokenResponse

タイプ: object

レスポンス本文には、リフレッシュしたアクセス・トークンが含まれます。

ソースを表示

• accessToken(optional): string
  この要素は、リソースへのアクセス権を提供し、15分後に失効します。 アクセス・トークンは、リフレッシュされたトークンによって定義されている時間(24時間)内に任意の回数リフレッシュできます。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• type(optional): string
  アイテム・タイプ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."
        }
    }
}

レスポンスの例(application/json)

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

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

トップに戻る

例

次の例では、新しいアクセス・トークンをリクエストします。

PUT .../applinks/token

リクエスト・ヘッダー

Applinkトークン・リフレッシュ・コールのリクエスト・パラメータは、一般的なリクエスト内ではなくコールのヘッダー内に用意されています。 たとえば、ヘッダー・パラメータは次のようになります。

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

先頭に戻る