Developer ConsoleとPostmanを設定
このレッスンでは、Adobe Developer Consoleでプロジェクトを設定し、Postman個のコレクションをダウンロードして、Platform APIの使用を開始できるようにします。
このチュートリアルのAPI演習を完了するには、お使いのオペレーティングシステム用のPostman アプリをダウンロードしてください。 Experience Platform APIを使用するために必要はありませんが、PostmanではAPI ワークフローが簡単になり、Adobe Experience PlatformにはAPI呼び出しの実行と動作の学習に役立つ多数のPostman コレクションが用意されています。 このチュートリアルの残りの部分では、Postmanに関する実務的な知識を前提としています。 サポートが必要な場合は、Postman ドキュメント を参照してください。
API ファーストで構築されるプラットフォーム。 インターフェイスオプションは、すべての主要タスクに対しても存在しますが、ある時点でPlatform APIを使用する必要がある場合があります。 たとえば、データの取り込み、サンドボックス間でのアイテムの移動、ルーチンワークの自動化、ユーザーインターフェイスが構築される前にプラットフォームの新機能を使用することなどが可能です。
データアーキテクトおよび データエンジニア は、このチュートリアル以外でPlatform APIを使用する必要がある場合があります。
権限が必要です
権限の設定 レッスンでは、このレッスンを完了するために必要なすべてのアクセス制御を設定します。
Adobe Developer Consoleの設定
Adobe Developer Consoleは、Adobe APIおよびSDKへのアクセス、ほぼリアルタイムのイベントのリッスン、ランタイムでの関数の実行、プラグインやApp Builder アプリケーションの構築を行うための開発者向けデベロッパーです。 Experience Platform APIへのアクセスに使用します。 詳しくは、Adobe Developer Console ドキュメント を参照してください
-
チュートリアルで使用するファイル用に、
Luma Tutorial Assetsという名前のローカルマシンにフォルダーを作成します。 -
ログインして、正しい組織であることを確認します
-
クイックスタート メニューで「新しいプロジェクトを作成」を選択します。
-
新しく作成したプロジェクトで、「プロジェクトを編集」ボタンを選択します
-
プロジェクトタイトルを
Luma Tutorial API Projectに変更します（会社の複数のユーザーがこのチュートリアルを受講している場合は、名前を最後に追加します） -
保存を選択
-
「APIを追加」を選択
-
Adobe Experience Platformを選択してリストをフィルタリング
-
使用可能なAPIの一覧で、Experience Platform APIを選択し、次へを選択します。
-
資格情報として OAuth サーバー間 を選択し、次を選択します。
-
AEP-Default-All-Users製品プロファイルを選択し、設定済みAPIを保存を選択します
-
これで、Developer Console プロジェクトが作成されました。
-
ページの体験版 セクションで、「Postman用にダウンロード」を選択し、OAuth Server-to-Server」を選択してPostman環境json ファイルをダウンロードします。
oauth_server_to_server.postman_environment.jsonをLuma Tutorial Assetsフォルダーに保存します。
システム管理者にAPI資格情報を役割に追加してもらいます
API資格情報を使用してExperience Platformとやり取りするには、システム管理者がAPI資格情報を前のレッスンで作成したロールに割り当てる必要があります。 システム管理者でない場合は、次の情報を送信します。
-
API資格情報（
Credential in Luma Tutorial API Project）の名前 -
資格情報の テクニカルアカウントメール （これにより、システム管理者が資格情報を見つけやすくなります）
資格情報
システム管理者の手順は次のとおりです。
-
Adobe Experience Platformにログインします
-
左側のナビゲーションで「権限」を選択すると、役割画面に移動します
-
Luma Tutorial Platformの役割を開く
-
「API資格情報」タブを選択します
-
「API資格情報を追加」を選択
-
リストが長い場合は、チュートリアル参加者が提供した テクニカルアカウントメール でフィルタリングする
Credential in Luma Tutorial API Project資格情報を見つけます -
資格情報を選択
-
保存を選択
Postmanの設定
-
Postmanのダウンロードとインストール
-
Postmanを開いてワークスペースを作成する
-
ダウンロードしたjson環境ファイルをインポートします。
oauth_server_to_server.postman_environment.json
-
Postmanで、ドロップダウンから環境を選択します
-
環境変数を表示するには、アイコンを選択します。
サンドボックス名とテナント IDの追加
SANDBOX_NAME変数とTENANT_ID変数およびCONTAINER_ID変数はAdobe Developer Consoleの書き出しに含まれていないので、手動で追加します。
-
Postmanで、環境変数を開きます
-
環境名の右側にある編集 リンクを選択します
-
新しい変数フィールドを追加で、
SANDBOX_NAMEと入力します -
両方の値フィールドに、前のレッスンでサンドボックスに付けた名前である
luma-tutorialを入力します。 サンドボックスに別の名前（luma-tutorial-ignatiusjreillyなど）を使用した場合は、その値を必ず使用してください。 -
新しい変数フィールドを追加で、
TENANT_IDと入力します -
Web ブラウザーに切り替えて、Experience Platformのインターフェイスに移動し、@記号 の後のURL の部分を抽出して、会社のテナント IDを検索します。 例えば、私のテナント IDは
techmarketingdemosですが、あなたのIDは異なります：
-
この値をコピーして、Postman Manage Environments画面に戻ります
-
テナント IDを両方の値フィールドに貼り付けます
-
新しい変数フィールドを追加で、
CONTAINER_IDと入力します -
両方の値フィールドに
globalを入力しますnote NOTE CONTAINER_IDは、チュートリアル中に何度か値が変更されるフィールドです。globalを使用すると、APIはPlatform アカウント内のAdobeが提供する要素とやり取りします。tenantを使用すると、APIは独自のカスタム要素と相互作用します。 -
保存を選択
API呼び出しを作成
アクセストークンの取得
Adobeには、Experience PlatformのAPIを調べるのに役立つPostman個の豊富なコレクションが用意されています。 これらのコレクションは、Adobe Experience Platform Postman Samples GitHub リポジトリ にあります。 このチュートリアル全体を通して、後で自社の会社にExperience Platformを実装する際に、このリポジトリを何度も使用するので、ブックマークを付ける必要があります。
最初のコレクションは、Adobe Identity Management Service （IMS） APIで動作します。 これは、Postman内からアクセストークンを取得する便利な方法です。
アクセストークンを生成するには：
-
Identity Management サービス API コレクション を
Luma Tutorial Assetsフォルダーにダウンロードします -
コレクションをPostmanにインポートします
-
リクエスト oAuth: アクセストークンのリクエストを選択し、送信を選択します
-
応答にアクセストークンを含む
200 OK応答が必要です
-
アクセストークンは、Postman環境の ACCESS_TOKEN 環境変数として自動的に保存する必要があります。
Platform APIの操作
次に、Platform API呼び出しを行って、すべてを正しく設定したことを確認します。
GitHub🔗でExperience Platform Postman コレクションを開きます。 このページには、さまざまなPlatform API用の多くのコレクションがあります。 私はそれをブックマークすることを強くお勧めします。
最初のAPI呼び出しを行います。
- Schema Registry API コレクション を
Luma Tutorial Assetsフォルダーにダウンロードします - Postmanにインポート
- Schema Registry API / スキーマ / リスト スキーマを開きます
- パラメーターと ヘッダー のタブを見て、先ほど入力した環境変数の一部が含まれている方法に注意してください。
- 「ヘッダー/値を受け入れる」フィールドが
application/vnd.adobe.xed-id+jsonに設定されていることに注意してください。 Schema Registry APIには、応答に異なる形式を提供する指定されたAccept ヘッダー値のいずれかが必要です。 - Sendを選択して、最初のPlatform API呼び出しを行います。
下の図のように、サンドボックス内の使用可能なAdobeが提供するXDM スキーマのリストを含む200 OK応答が正常に終了したことを願います。
呼び出しが成功しなかった場合は、API呼び出しのエラー応答の詳細を使用してデバッグし、上記の手順を確認します。 行き詰まった場合は、 コミュニティフォーラム でヘルプをリクエストするか、このページの右側にあるリンクを使用して「問題を記録」してください。
Platformの権限、サンドボックス、およびPostmanを設定したら、 スキーマ内のモデルデータ を準備できます。