Experience Platform API の認証とアクセス

このドキュメントでは、Experience Platform API を呼び出すために Adobe Experience Platform 開発者アカウントにアクセスするための順を追ったチュートリアルを提供します。 このチュートリアルの最後に、すべてのExperience Platform API呼び出しでヘッダーとして必要な次の資格情報を生成または収集します。

アプリケーションとユーザーのセキュリティを維持するには、Experience Platform APIへのあらゆるリクエストが、OAuthなどの標準を使用して認証および承認される必要があります。

このチュートリアルでは、以下のフローチャートに示すように、Experience Platform API呼び出しを認証するために必要な資格情報を収集する方法について説明します。 必要な資格情報のほとんどは、最初の1回限りの設定で収集できます。 ただし、アクセストークンは24時間ごとに更新する必要があります。

前提条件 prerequisites

Experience Platform APIの呼び出しを正常に行うには、次のものが必要です。

このチュートリアルを完了するには、Adobe IDも必要です。 Adobe ID をお持ちでない場合は、次の手順で作成できます。

Experience Platformの開発者とユーザーのアクセス権を取得 gain-developer-user-access

Adobe Developer Consoleで統合を作成する前に、アカウントにAdobe Admin ConsoleのExperience Platform製品プロファイルに対する開発者権限とユーザー権限が必要です。

開発者アクセス gain-developer-access

お客様の組織のAdmin Console管理者に連絡して、Experience Platform製品プロファイルに開発者として追加してください。 製品プロファイルの開発者アクセスを管理する方法について詳しくは、Admin Consoleのドキュメントを参照してください。

開発者として割り当てられたら、Adobe Developer Consoleで統合の作成を開始できます。 これらの統合は、外部アプリやサービスからAdobe APIへのパイプラインです。

ユーザーアクセスの取得 gain-user-access

Admin Console管理者は、同じ製品プロファイルにユーザーとして追加する必要があります。 ユーザーアクセスを使用すると、実行したAPI操作の結果をUIで確認できます。

詳しくは、Admin Consoleでのユーザーグループの管理に関するガイドを参照してください。

API キー（クライアント ID）と組織IDの生成 generate-credentials

Admin Consoleを通じてExperience Platformへの開発者およびユーザーのアクセス権を付与したら、次の手順は、Adobe Developer Consoleで{ORG_ID}および{API_KEY}の資格情報を生成することです。 これらの資格情報は一度生成するだけで済み、今後のExperience Platform API呼び出しで再利用できます。

プロジェクトへのExperience Platformの追加 add-platform-to-project

Adobe Developer Console に移動し 、Adobe ID を使用してログインします。 次に、Adobe Developer Console のドキュメントの空のプロジェクトの作成チュートリアルで概説されている手順に従います。

新しいプロジェクトを作成したら、プロジェクトの概要​画面で「API​を追加」を選択します。

「APIを追加」オプションがハイライト表示された

API の追加​画面が表示されます。 Adobe Experience Platform​の商品アイコンを選択し、次へ​を選択する前に​ Experience Platform API ​を選択します。

OAuth サーバー間認証タイプを選択します select-oauth-server-to-server

次に、OAuth Server-to-Server​認証タイプを選択して、アクセストークンを生成し、Experience Platform APIにアクセスします。 次​を選択する前に、資格情報名 テキストフィールドに資格情報に意味のある名前を付けます。

統合の製品プロファイルの選択 select-product-profiles

Configure API​画面で、AEP-Default-All-Users​を選択し、アクセスを取得する追加の製品プロファイルを選択します。

準備ができたら、設定したAPI​を保存を選択します。

Experience Platform APIとの統合を設定するための上記の手順のチュートリアルは、以下のビデオチュートリアルでも利用できます。

資格情報の収集 gather-credentials

APIがプロジェクトに追加されると、プロジェクトの​OAuth サーバー間 ページに、Experience Platform APIへのすべての呼び出しに必要な次の資格情報が表示されます。

アクセストークンの生成 generate-access-token

次の手順では、Experience Platform API呼び出しで使用する{ACCESS_TOKEN}資格情報を生成します。 {API_KEY}および{ORG_ID}の値とは異なり、Experience Platform APIを引き続き使用するには、24時間ごとに新しいトークンを生成する必要があります。 次に示すように、アクセストークンを生成する​ アクセストークンを生成 ​します。

API リファレンスドキュメントで認証資格情報を直接作成および取得する get-credentials-functionality

2024年11月リリースのExperience Platform以降では、Developer Consoleに移動することなく、API リファレンスページからExperience Platform APIを直接使用するための資格情報を取得できます。 Flow Service API – 宛先ページ ​から以下の例を表示します。

Experience Platform APIを呼び出すための資格情報を取得するには、任意のExperience Platform API リファレンスページに移動し、ページ上部の​ ログイン ​を選択します。 個人アカウント​または​ 会社または学校アカウント ​でログインします。

ログイン後、新しい資格情報を作成​を選択して、Experience Platform APIにアクセスするための新しい資格情報のセットを作成します。

次に、ドロップダウンセレクターを使用して資格情報ウィンドウを開き、アクセストークンを生成し、API キーと組織IDを取得します。 資格情報をAPI リファレンスページの ブロックにコピーして、Experience Platform APIの操作を開始します。

[非推奨]{class="badge negative"} JSON Web トークン（JWT）を生成 jwt

アクセス資格情報のテスト test-credentials

アクセストークン、API キー、組織IDの3つの必要な資格情報をすべて収集したら、次のAPI呼び出しを試すことができます。 この呼び出しは、組織で使用可能なすべての標準Experience Data Model （XDM） クラスを一覧表示します。 Postmanで呼び出しをインポートして実行します。

リクエスト

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
  -H 'x-api-key: {{API_KEY}}' \
  -H 'x-gw-ims-org-id: {{ORG_ID}}'

応答

以下に示す回答と類似している場合、資格情報は有効で機能しています。 （スペース節約のために応答は部分的に表示されています。）

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

必要な属性ベースのアクセス制御権限を取得 get-abac-permissions

Experience Platform内の複数のリソースにアクセスまたは変更するには、適切なアクセス制御権限が必要です。 システム管理者は、必要な権限を付与できます。 詳細については、「役割のAPI資格情報の管理」の節を参照してください。

APIを介してExperience Platform リソースにアクセスするために必要な権限をシステム管理者が付与する方法の詳細については、次のビデオチュートリアルも参照してください。

Postmanを使用したAPI呼び出しの認証とテスト use-postman

Postmanは、開発者がRESTful APIを探索およびテストできる人気のあるツールです。 Experience Platform Postmanのコレクションと環境を使用すると、Experience Platform APIを使用した作業を高速化できます。 Experience PlatformでPostmanを使用する方法と、コレクションと環境の使用を開始する方法について説明します。

PostmanとExperience Platformのコレクションおよび環境の使用について詳しくは、以下のビデオチュートリアルを参照してください。

Experience Platform APIで使用するPostman環境をダウンロードして読み込む

Postman コレクションを使用してアクセストークンを生成

Identity Management Service Postman コレクション ​をダウンロードし、以下のビデオでアクセストークンの生成方法をご覧ください。

Experience Platform API Postman コレクションをダウンロードし、APIを操作する

システム管理者：Experience Platform権限による開発者およびAPI アクセス制御の付与 grant-developer-and-api-access-control

Adobe Developer Consoleで統合を作成する前に、アカウントにExperience Platform製品プロファイルの開発者およびユーザー権限が必要です。

製品プロファイルへの開発者の追加 add-developers-to-product-profile

Admin Consoleに移動し、Adobe IDでログインします。

ナビゲーションバーから「Products」を選択し、商品リストから「Adobe Experience Platform」を選択します。

「製品プロファイル」タブから、AEP-Default-All-Users​を選択します。 または、検索バーを使用して、名前を入力して製品プロファイルを検索します。

「開発者」タブを選択し、「開発者を追加」を選択します。

開発者を追加 ダイアログが表示されます。 開発者の​ 電子メールまたはユーザー名 ​を入力します。 有効な電子メールまたはユーザー名は、開発者の詳細を表示します。 「保存」を選択します。

開発者が正常に追加され、開発者 タブに表示されます。

役割へのAPI資格情報の割り当て

Experience Platform APIで操作を使用して実行するには、役割の特定の権限に加えて、API資格情報を追加する必要があります。 詳細については、「役割のAPI資格情報の管理」の節を参照してください。

製品プロファイルに開発者を追加し、役割にAPIを割り当てるための上記の手順のチュートリアルは、次のビデオチュートリアルでも利用できます。

その他のリソース additional-resources

Experience Platform APIの使用を開始するための詳細なヘルプについては、以下にリンクされている関連リソースを参照してください

次の手順 next-steps

このドキュメントを読むことで、Experience Platform APIのアクセス資格情報を収集し、正常にテストできました。 これで、​ ドキュメント ​全体で提供されるAPI呼び出しの例に従うことができます。

このチュートリアルで収集した認証値に加えて、多くのExperience Platform APIでは、有効な{SANDBOX_NAME}をヘッダーとして指定する必要があります。 詳しくは、サンドボックスの概要を参照してください。