1. API認証と承認

アクセス トークンと更新トークンを取得する

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このトピックでは、アクセス トークンを取得する2つの方法について説明します。1つ目の方法は、APIキーを使用してアクセス トークンを取得することです。2番目の方法は、更新トークンを使用してアクセス トークンを取得することです。

APIキーを使用してアクセス トークンを取得する

APIキーを使用してアクセス トークンを取得するには:

  • 認証エンドポイントをPOST呼び出して、アクセストークンを取得します。APIキーとその他のパラメーターを渡します。応答には、アクセストークンと更新トークンが含まれます。

APIキーを使用してアクセス トークンを取得するリクエストを作成するには、次の詳細を使用します。

方式： POST

エンドポイント： https://api.rfksrv.com/account/1/access-token

鍵

種類

形容

価値

x-api-key

糸

必須。これをヘッダーに渡します

Sitecore Search生成する秘密鍵。これは、最初にサインアップするときにアカウントマネージャーから入手できます。

この値は、Developer Resources > API Accessに移動するとSearchで確認できます。

該当なし

scope

糸

必須。

呼び出すことができるSitecore Search APIを定義する権限。

APIキーに割り当てられているスコープは、Developer Resources > API Accessに移動してSearchで確認できます。

  • discover

  • event

accessExpiry

整数

随意。

アクセストークンの有効性(ミリ秒単位)。

このキーを追加しない場合、デフォルトのアクセストークンの有効期限は1日または86400000ミリ秒です。

該当なし

refreshExpiry

整数

随意。

更新トークンの有効性 (ミリ秒単位)。

このキーを追加しない場合、デフォルトの更新トークンの有効期限は7日または604800000ミリ秒です。

該当なし

以下は、有効期間が12時間のアクセストークンと有効期間が3日間の更新トークンに対するCURL要求の例です。

curl -X POST \

  https://api.rfksrv.com/account/1/access-token \

  -H 'Content-Type: application/json' \

  -H 'x-api-key: 01-90d33624-99f708fa77a1e94a25c4a1afd0f28a4c23ff5251' \

  -d '{"scope":["discover"],"accessExpiry": 43200000, \

"refreshExpiry": 259200000}'

応答例:

{

    "accessToken": "167dgw2vyy733",

    "refreshToken": "1n555d88sss448",

    "accessTokenExpiry": 43200000,

    "refreshTokenExpiry": 259200000

}

更新トークンを使用してアクセス トークンを取得する

更新トークンを使用してアクセストークンを取得するには:

  • 認証エンドポイントへのPUT呼び出しを行います。ヘッダーに更新トークンを渡します。応答には新しいアクセストークンが含まれています。

更新トークンを使用してアクセス トークンを取得する要求を作成するには、次の詳細を使用します。

方式： PUT

エンドポイント： https://api.rfksrv.com/account/1/access-token

パラメーター

種類

形容

refresh-token

糸

必須。これをヘッダーに渡します。

APIキーを再度渡さずに新しいアクセス キーを取得するために使用できるシークレット トークン。APIキーを使用してアクセス トークンを取得すると、応答で更新トークンが取得されます。

メモ

この呼び出しを行うときに、更新トークンがまだ有効であることを確認してください。

CURLリクエストの例を次に示します。

curl -X PUT \

  https://<base-url>api.rfksrv.com/account/1/access-token \

  -H 'Authorization': Bearer 1n555d88sss448<refresh-token>' \

  -H 'Content-Type: application/json'

応答例:

{
    "accessToken": "187dgb6vmy733"
}
この記事を改善するための提案がある場合は、 お知らせください!