ドキュメント Experience Platform Experience Platform の概要

Experience Platform API の認証とアクセス

最終更新日： 2025年5月5日

トピック：
API

作成対象：

開発者

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

{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}

ヒント

上記の 3 つの資格情報に加えて、多くのExperience Platform API では、有効な {SANDBOX_NAME} をヘッダーとして指定する必要もあります。サンドボックスについて詳しくは、サンドボックスの概要を参照してください。また、組織で使用可能なサンドボックスの一覧表示について詳しくは、サンドボックス管理エンドポイントのドキュメントを参照してください。

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

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

1 回限りの初期設定と後続の各セッションの認証フローの要件

前提条件

Experience Platform API を正常に呼び出すには、次の条件を満たす必要があります。

Adobe Experience Platformへのアクセス権を持つ組織。
Admin Console管理者（製品プロファイルの開発者およびユーザーとして追加できます）。
Experience Platform システム管理者。API を使用してExperience Platformの様々な部分で読み取りまたは書き込み操作を実行するために必要な、属性ベースのアクセス制御をユーザーに付与できます。

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

Adobe Developer Console に移動します。
新しいアカウントを作成 を選択します。
新規登録プロセスを完了します。

Experience Platformの開発者およびユーザーアクセスの取得

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

開発者アクセス権の取得

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

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

ユーザーアクセスの取得

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

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

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

メモ

Privacy Service API ガイドのこのドキュメントを参照する場合は、ガイドに戻って、Privacy Service に固有のアクセス認証情報を生成することができます。

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

ヒント

Developer Consoleに移動する代わりに、Experience Platform API を使用するために必要なすべての認証資格情報を、API リファレンスドキュメントページから直接取得できます。機能について 🔗 詳細を参照。

プロジェクトへのExperience Platformの追加

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

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

ヒント

複数の組織用にプロビジョニングされている場合は、インターフェイスの右上隅にある組織セレクターを使用して、必要な組織に属していることを確認します。

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

API の追加 画面が表示されます。 Adobe Experience Platform の商品アイコンを選択し、「Experience Platform API」を選択してから次へを選択します。

API を追加画面でExperience Platform API を選択します。

ヒント

ドキュメントを表示 オプションを選択して、別のブラウザーウィンドウに移動し、Experience Platform API リファレンスドキュメントを参照します。

OAuth サーバー間認証タイプを選択します

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

重要

今後サポートされるトークン生成方法は、OAuth サーバー間 メソッドのみです。以前サポートされていた サービスアカウント（JWT） メソッドは非推奨となり、新しい統合用に選択することはできません。 JWT 認証方法を使用した既存の統合は 2025 年 6 月 30 日（PT）まで引き続き機能しますが、Adobeでは、その日までに既存の統合を新しい OAuth サーバー間認証方法に移行することを強くお勧めします。詳しくは、「非推奨」の節を参照してください。{type=negative}JSON web トークン（JWT）を生成ます。

Experience Platform API の OAuth サーバー間認証方法を選択します。

統合用の製品プロファイルの選択

API を設定 画面で、「AEP-Default-All-Users」を選択し、アクセス権を取得するその他の製品プロファイルも選択します。

重要

Experience Platformの特定の機能にアクセスするには、必要な属性ベースのアクセス制御権限を付与するシステム管理者も必要です。詳しくは、必要な属性ベースのアクセス制御権限の取得の節を参照してください。

統合用の製品プロファイルを選択します。

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

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

video poster

https://video.tv.adobe.com/v/31656/?learn=on&captions=jpn

資格情報の収集

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

Developer Console で API を追加した後の統合情報

{API_KEY} （クライアント ID）
{ORG_ID} （組織 ID）

アクセストークンの生成

次の手順では、Experience Platform API 呼び出しで使用する {ACCESS_TOKEN} 資格情報を生成します。 {API_KEY} と {ORG_ID} の値とは異なり、Experience Platform API を引き続き使用するには、新しいトークンを 24 時間ごとに生成する必要があります。「アクセストークンを生成」を選択します（下図を参照）。

アクセストークンの生成方法を表示

TIP

また、Postman環境とコレクションを使用してアクセストークンを生成することもできます。詳しくは、Postmanを使用した API 呼び出しの認証とテストに関する節を参照してください。

認証資格情報の作成と取得については、API リファレンスドキュメントを参照してください。

2024 年 11 月リリースのExperience Platform以降、Developer Console にアクセスしなくても、API リファレンスページからExperience Platform API を直接使用するための資格情報を取得できます。フローサービス API – 宛先ページから、以下の例を表示します。

API リファレンスページの上部でハイライト表示された資格情報の取得機能。

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

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

Experience Platform API にアクセスするための新しい資格情報を作成します。

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

ドロップダウンセレクターを使用して資格情報を表示し、アクセストークンを生成します。

TIP

Experience Platform API リファレンスドキュメントの様々なエンドポイントページ間を移動しても、ページ上部の資格情報ブロックは表示されたままになります。

非推奨 JSON web トークン（JWT）を生成

WARNING

アクセストークンを生成する JWT メソッドは非推奨（廃止予定）になりました。すべての新しい統合は、OAuth サーバー間認証方法を使用して作成する必要があります。また、Adobeでは、統合を引き続き機能させるには、2025 年 6 月 30 日（PT）までに既存の統合を OAuth 方式に移行する必要があります。以下の重要なドキュメントをお読みください。

非推奨（廃止予定）の情報の表示

次の手順では、アカウントの資格情報に基づいて JSON web トークン（JWT）を生成します。この値は、Experience Platform API 呼び出しで使用する {ACCESS_TOKEN} 資格情報を生成するために使用されます。この資格情報は、24 時間ごとに再生成する必要があります。

IMPORTANT

このチュートリアルを目的として、次の手順ではDeveloper Console内で JWT を生成する方法の概要を説明します。ただし、この生成方法は、テストおよび評価の目的でのみ使用してください。

通常の使用では、JWT を自動的に生成する必要があります。プログラムによる JWT の生成方法について詳しくは、Adobe Developerのサービスアカウント認証ガイドを参照してください。

左側のナビゲーションで「サービスアカウント（JWT）」を選択し、「JWT を生成」を選択します。

「カスタム JWT を生成」の下にあるテキストボックスに、Experience Platform API をサービスアカウントに追加する際に以前に生成した秘密鍵の内容を貼り付けます。次に、「トークンを生成」を選択します。

ページが更新され、生成された JWT と、アクセストークンを生成できるサンプル cURL コマンドが表示されます。このチュートリアルでは、「生成された JWT」の横にある「コピー を選択して、トークンをクリップボードにコピーします。

アクセストークンの生成

JWT を生成したら、API 呼び出しで JWT を使用して {ACCESS_TOKEN} を生成できます。 {API_KEY} と {ORG_ID} の値とは異なり、Experience Platform API を引き続き使用するには、新しいトークンを 24 時間ごとに生成する必要があります。

リクエスト

次のリクエストは、ペイロードで指定された資格情報に基づいて新しい {ACCESS_TOKEN} を生成します。このエンドポイントは、フォームデータのみをペイロードとして受け入れるので、multipart/form-data の Content-Type ヘッダーを指定する必要があります。

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

プロパティ

説明

{API_KEY}

[ 前の手順 ] で取得した {API_KEY} ール（クライアント ID。

{SECRET}

前の手順で取得したクライアント秘密鍵。

{JWT}

前の手順で生成した JWT。

NOTE

同じ API キー、クライアントの秘密鍵、JWT を使用して、セッションごとに新しいアクセストークンを生成できます。これにより、アプリケーションでのアクセストークンの生成を自動化できます。

応答

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

プロパティ

説明

token_type

タイプ of 返されるトークン。アクセストークンの場合、この値は常に bearer です。

access_token

生成された {ACCESS_TOKEN}。単語 Bearer のプレフィックスが付いたこの値は、すべてのExperience Platform API 呼び出しの Authentication ヘッダーとして必要です。

expires_in

アクセストークンの有効期限が切れるまでの残り時間（ミリ秒）。この値が 0 に達した場合、Experience Platform API の使用を継続するには、新しいアクセストークンを生成する必要があります。

アクセス資格情報のテスト

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

recommendation-more-help

リクエスト

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"
    }
  ]
}

IMPORTANT

上記の呼び出しはアクセス資格情報をテストするには十分ですが、属性ベースの適切なアクセス制御権限がないと、複数のリソースにアクセスして変更することができません。詳しくは、以下の 必要な属性ベースのアクセス制御権限の取得 節を参照してください。

必要な属性ベースのアクセス制御権限の取得

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

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

video poster

https://video.tv.adobe.com/v/31656/?learn=on&t=159&captions=jpn

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

Postman は、開発者が RESTful API を参照およびテストできる一般的なツールです。 Experience Platform Postmanのコレクションと環境を使用すると、Experience Platform API の操作を高速化できます。詳しくは、Experience PlatformでのPostmanの使用およびコレクションと環境の基本を学ぶを参照してください。

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

Experience Platform API で使用するPostman環境のダウンロードと読み込み

video poster

https://video.tv.adobe.com/v/31656/?learn=on&t=106&captions=jpn

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

Identity Management サービス Postman コレクションをダウンロードし以下のビデオを視聴してアクセストークンの生成方法を確認してください。

video poster

https://video.tv.adobe.com/v/34080/?learn=on&captions=jpn

Experience Platform API Postman コレクションをダウンロードし、API とやり取りする

video poster

https://video.tv.adobe.com/v/34079/?learn=on&captions=jpn

システム管理者：Experience Platform権限を使用して開発者および API アクセス制御を付与します

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

NOTE

システム管理者のみが、権限の API 資格情報を表示および管理できます。

製品プロファイルへの開発者の追加

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

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

Adobe Experience Platform製品がハイライト表示されたAdobe Admin Consoleの製品ページ。

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

検索バーとAEP-Default-All-Users 製品がハイライト表示された製品プロファイルページ。

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

「開発者」タブが表示され、「開発者を追加」オプションがハイライト表示されます。

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

開発者情報が入力され、「保存」オプションがハイライト表示された開発者を追加ダイアログ

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

新しく追加された開発者がハイライト表示された、追加されたすべての開発者のリストを表示する「開発者」タブ。

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

NOTE

Experience Platform UI で API をロールに割り当てることができるのは、システム管理者のみです。

Experience Platform API を使用して操作を実行するには、システム管理者は、役割の特定の権限セットに加えて、API 資格情報を追加する必要があります。詳しくは、「役割の API 資格情報の管理に関する節を参照しください。

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

video poster

https://video.tv.adobe.com/v/3446399/?learn=on&captions=jpn

その他のリソース

Experience Platform API の概要の詳細については、以下にリンクされている追加のリソースを参照してください

Experience Platform API の認証とアクセスビデオチュートリアルページ
アクセストークンを生成するための Identity Management サービス Postman コレクション
Experience Platform API Postman コレクション

次の手順

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

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

Experience Platform API の認証とアクセス

前提条件

Experience Platformの開発者およびユーザーアクセスの取得

開発者アクセス権の取得

ユーザーアクセスの取得

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

プロジェクトへのExperience Platformの追加

OAuth サーバー間 ​ 認証タイプを選択します

統合用の製品プロファイルの選択

資格情報の収集

アクセストークンの生成

認証資格情報の作成と取得については、API リファレンスドキュメントを参照してください。

​ 非推奨 ​ JSON web トークン（JWT）を生成

アクセス資格情報のテスト

必要な属性ベースのアクセス制御権限の取得

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

システム管理者：Experience Platform権限を使用して開発者および API アクセス制御を付与します

製品プロファイルへの開発者の追加

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

その他のリソース

次の手順

OAuth サーバー間認証タイプを選択します

非推奨 JSON web トークン（JWT）を生成