1. API認証と認可

アクセストークンとリフレッシュトークンを取得しましょう

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

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

このトピックでは、アクセストークンを取得する2つの方法について説明します。1つ目はAPIキーを使ってアクセストークンを取得する方法です。2つ目はリフレッシュトークンを使ってアクセストークンを取得する方法です。

APIキーを使ってアクセストークンを取得してください

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

  • 認証エンドポイントに POST コールをしてアクセストークンを取得します。APIキーといくつかのパラメータを渡します。レスポンスにはアクセストークンとリフレッシュトークンが含まれます。

APIキーを使ってアクセストークンを取得するリクエストを作成するには、以下の詳細をご利用ください:

方法: POST

エンドポイント: https://api.rfksrv.com/account/{domainid}/access-token

キー

種類

概要

価値

X-API-キー

ストリング

必須です。ヘッダーにこれを渡してください。Sitecore Searchが生成する秘密鍵です。これは最初にサインアップしたときにアカウントマネージャーから受け取ります。Developer Resources > API Accessに行くことでこの値をSearchで確認できます。

該当なし

範囲

ストリング

Required。どのSitecore Search APIを呼び出せるかを定義する権限です。Developer Resources > API Accessに行くことでSearchでAPIキーに割り当てられたスコープを確認できます。

発見イベント

アクセス

整数

オプション。アクセストークンの有効性はミリ秒単位です。このキーを追加しなければ、デフォルトのアクセストークンの有効期限は1日または8640000ミリ秒となります。

該当なし

更新期限

整数

オプション。リフレッシュトークンの有効性(ミリ秒単位)。このキーを追加しなければ、デフォルトのリフレッシュトークンの有効期限は7日、すなわち60480000ミリ秒となります。

該当なし

以下は、有効期限12時間のアクセストークンと有効期限3日のリフレッシュトークンに関するサンプルCURLリクエストです。

curl -X POST \

https://api.rfksrv.com/account/987654321/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/{domainid}/access-token

パラメータ

種類

概要

リフレッシュトークン

ストリング

必須です。これをヘッダーで渡してください。APIキーを再度渡さずに新しいアクセスキーを取得するための秘密トークンです。APIキーを使ってアクセストークンを取得すると、リフレッシュトークンはレスポンスで表示されます。注意この呼び出しを行う際には、リフレッシュトークンがまだ有効であることを確認してください。

以下はCURLのサンプル依頼です:

curl -X PUT \

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

-H 'Authorization': Bearer 1n555d88sss448' \

-H 'Content-Type: application/json'

サンプル回答:

{ "accessToken": "187dgb6vmy733" }

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