Reactor API の認証とアクセス
Reactor API を使用してタグ拡張機能を作成および管理するには、各リクエストに次の認証ヘッダーを含める必要があります。
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
このガイドでは、Adobe Developer Console を使用してこれらの各ヘッダーの値を収集し、Reactor API の呼び出しを開始する方法について説明します。
Adobe Experience Platform への開発者のアクセス gain-developer-access
Reactor API の認証値を生成する前に、開発者が Experience Platform にアクセスできる必要があります。開発者アクセス権を取得するには、Experience Platform 認証チュートリアルの最初の手順に従ってください。 ユーザーアクセスを取得手順を完了したら、このチュートリアルに戻って Reactor API に固有の資格情報を生成します。
アクセス資格情報の生成 generate-access-credentials
Adobe Developer Console を使用して、次の 3 つのアクセス資格情報を生成する必要があります。
{ORG_ID}
{API_KEY}
{ACCESS_TOKEN}
組織の ID ({ORG_ID}
)と API キー({API_KEY}
)は、最初に生成された後、今後の API 呼び出しで再利用できます。 ただし、アクセストークン({ACCESS_TOKEN}
)は一時的なもので、24 時間ごとに再生成する必要があります。
これらの値を生成する手順については、以下で詳しく説明します。
1 回限りのセットアップ one-time-setup
Adobe Developer Console に移動し 、Adobe ID を使用してログインします。次に、Developer Console のドキュメントにある空のプロジェクトを作成に関するチュートリアルで説明されている手順に従います。
プロジェクトを作成したら、プロジェクトの概要 画面で「API を追加」を選択します。
API の追加 画面が表示されます。 使用可能な API のリストから「Experience Platform Launch API」を選択して、「次へ」を選択します。
次に、認証タイプを選択してアクセストークンを生成し、Experience Platform API にアクセスします。
「次へ」をクリックして続行します。
次の画面では、API 統合に関連付ける 1 つ以上の製品プロファイルを選択します。
リストから目的の製品プロファイルを選択し、「設定済み API を保存」を選択して API の登録を完了します。
資格情報の収集 gather-credentials
API がプロジェクトに追加されると、プロジェクトの Experience Platform API ページに、Experience Platform API へのすべての呼び出しで必要な次の資格情報が表示されます。
{API_KEY}
( クライアント ID){ORG_ID}
( 組織 ID)
アクセストークンの生成 generate-access-token
次の手順では、Experience Platform API 呼び出しで使用する {ACCESS_TOKEN}
資格情報を生成します。 {API_KEY}
と {ORG_ID}
の値とは異なり、Experience Platform API を引き続き使用するには、新しいトークンを 24 時間ごとに生成する必要があります。
使用例に応じて、アクセストークンを生成するための 2 つのオプションがあります。
アクセストークンの手動生成 manual
新しい {ACCESS_TOKEN}
を手動で生成するには、次に示すように、資格情報/OAuth サーバー間 に移動し、「アクセストークンを生成」を選択します。
新しいアクセストークンが生成され、トークンをクリップボードにコピーするためのボタンが表示されます。この値は、必要な Authorization ヘッダーに使用され、Bearer {ACCESS_TOKEN}
の形式で指定する必要があります。
トークン生成の自動化 auto-token
また、Postman環境とコレクションを使用してアクセストークンを生成することもできます。 詳しくは、Experience Platform API 認証ガイドの Postmanを使用した API 呼び出しの認証およびテストに関する節を参照してください。
API 資格情報のテスト test-api-credentials
このチュートリアルの手順に従うことで、{ORG_ID}
、{API_KEY}
および {ACCESS_TOKEN}
に有効な値を指定できます。 これらの値を、Reactor API への簡単な cURL リクエストで使用してテストできるようになりました。
まず、すべての会社をリストする API 呼び出しを試みます。
アクセス資格情報が機能していることを確認したら、引き続き他の API リファレンスドキュメントを参照して、API の多くの機能を確認します。
API 呼び出し例の読み取り read-sample-api-calls
各エンドポイントガイドには、API 呼び出しの例とリクエストの形式を指定する方法が示されています。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。サンプル API 呼び出しのドキュメントで使用されている規則については、Experience Platform API の開始ガイドのAPI 呼び出し例の読み方に関する節を参照してください。
次の手順 next-steps
使用するヘッダーを理解できたので、Reactor API への呼び出しを開始できます。 開始するには、エンドポイントガイドの 1 つを選択します。