Privacy Service API の認証とアクセス
作成対象：
- 開発者
このガイドでは、Adobe Experience Platform Privacy Service API を呼び出す前に知っておく必要があるコア概念の概要を説明します。
前提条件
このガイドでは、Privacy Service と、Adobe Experience Cloud アプリケーション全体のデータ主体（お客様）からのアクセスリクエストや削除リクエストを管理する方法に関する十分な知識が必要です。
API のアクセス資格情報を作成するには、組織内の管理者がAdobe Admin Console内でPrivacy Serviceの製品プロファイルを事前に設定している必要があります。 API 統合に割り当てる製品プロファイルによって、Privacy Service機能にアクセスする際に統合に付与される権限が決まります。 詳しくは、Privacy Service権限の管理に関するガイドを参照してください。
必須ヘッダーの値の収集
Privacy Service API を呼び出すには、まず必要なヘッダーで使用されるアクセス資格情報を収集する必要があります。
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
これらの値は、Adobe Developer Console を使用して生成されます。 {ORG_ID} と {API_KEY} は 1 回だけ生成する必要があり、今後の API 呼び出しで再利用できます。 ただし、{ACCESS_TOKEN} は一時的なもので、24 時間ごとに再生成する必要があります。
これらの値を生成する手順については、以下で詳しく説明します。
1 回限りのセットアップ
Adobe Developer Console に移動し 、Adobe ID を使用してログインします。次に、Developer Console のドキュメントにある空のプロジェクトを作成に関するチュートリアルで説明されている手順に従います。
新しいプロジェクトを作成したら、「プロジェクトに追加」を選択し、ドロップダウンメニューから「API」を選択します。
Privacy Service API を選択します。
API の追加 画面が表示されます。 「Experience Cloud」を選択して使用可能な API のリストを絞り込み、「Privacy Service API」のカードを選択して 「次へ」を選択します。
TIP次に、認証タイプを選択してアクセストークンを生成し、Privacy Service API にアクセスします。
IMPORTANT
製品プロファイルを使用した権限の割り当て
最後の設定手順では、この統合の権限継承元となる製品プロファイルを選択します。 複数のプロファイルを選択すると、それらの権限セットが統合のために組み合わされます。
NOTE終了したら、「設定済み API を保存」を選択します。
API がプロジェクトに追加されると、プロジェクトの Privacy Service API ページに、Privacy Service API へのすべての呼び出しで必要な次の資格情報が表示されます。
{API_KEY}（ クライアント ID）{ORG_ID}（ 組織 ID）
各セッションの認証
収集する必要がある最終的な必須資格情報は、{ACCESS_TOKEN} です。これは、Authorization ヘッダーで使用されます。 {API_KEY} や {ORG_ID} の値とは異なり、API を引き続き使用するには、24 時間ごとに新しいトークンを生成する必要があります。
一般に、アクセストークンは次の 2 とおりの方法で生成されます。
- テストおよび開発用に 手動でトークンを生成します。
- API 統合用の トークン生成の自動化。
トークンの手動生成
新しい {ACCESS_TOKEN} を手動で生成するには、次に示すように、資格情報/OAuth サーバー間 に移動し、「アクセストークンを生成」を選択します。
新しいアクセストークンが生成され、トークンをクリップボードにコピーするためのボタンが表示されます。この値は、必要な Authorization ヘッダーに使用され、Bearer {ACCESS_TOKEN} の形式で指定する必要があります。
トークン生成の自動化
また、Postman環境とコレクションを使用してアクセストークンを生成することもできます。 詳しくは、Experience Platform API 認証ガイドの Postmanを使用した API 呼び出しの認証およびテストに関する節を参照してください。
API 呼び出し例の読み取り
各エンドポイントガイドには、API 呼び出しの例とリクエストの形式を指定する方法が示されています。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。サンプル API 呼び出しのドキュメントで使用されている規則については、Experience Platform API の開始ガイドのAPI 呼び出し例の読み方に関する節を参照してください。