ドキュメントExperience PlatformDeveloper ConsoleとPostmanのセットアップ

Developer Consoleと Postman のセットアップ

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：
  • API

作成対象：

  • 初心者
  • 中級
  • 開発者

このレッスンでは、Adobe Developer Consoleでプロジェクトを設定し、Postman のコレクションをダウンロードして、Platform API の使用を開始します。

このチュートリアルの API の演習を完了するには、 お使いのオペレーティングシステム用のPostman アプリをダウンロードします。 Experience PlatformAPI を使用するために必須ではありませんが、Postmanを使用すると API ワークフローが容易になり、Adobe Experience Platformには API 呼び出しを実行し、その動作を学ぶのに役立つ多数のPostman コレクションが用意されています。 このチュートリアルの残りの部分では、Postmanに関する実務知識を前提としています。 サポートについては、Postmanのドキュメントを参照してください。

Platform は、API ファーストで構築されています。 すべての主要タスクに対してインターフェイスオプションも存在しますが、どこかの時点で Platform API を使用したい場合があります。 例えば、データの取り込み、サンドボックス間での項目の移動、ルーチンタスクの自動化、Platform の新機能の使用などを、ユーザーインターフェイスが作成される前に行います。

データアーキテクト および データエンジニア は、このチュートリアル以外で Platform API の使用が必要になる場合があります。

必要な権限

権限の設定レッスンでは、このレッスンを完了するために必要なすべてのアクセス制御を設定します。

Adobe Developer Consoleの設定

Adobe Developer ConsoleからAdobeAPI や SDK にアクセスしたり、ほぼリアルタイムのイベントをリッスンしたり、ランタイムで関数を実行したり、プラグインやApp Builder アプリケーションを構築したりできます。 Experience PlatformAPI にアクセスする際に使用します。 詳しくは、Adobe Developer Consoleのドキュメントを参照してください

  1. このチュートリアルで使用するファイル用に、Luma Tutorial Assets という名前のフォルダーをローカルマシンに作成します。

  2. Adobe Developer Console を開きます

  3. ログインし、正しい組織に属していることを確認します

  4. ​ クイックスタート ​ メニューの 新規プロジェクトを作成 を選択します。

    新規プロジェクトを作成

  5. 新しく作成されたプロジェクトで、「プロジェクトを編集」ボタンを選択します

  6. プロジェクトタイトル を Luma Tutorial API Project に変更します（会社の複数のユーザーがこのチュートリアルを受講している場合は、最後に名前を追加します）。

  7. 「保存」を選択します

    Adobe Developer Console プロジェクト API 設定

  8. 「API を追加」を選択します。

    Adobe Developer Console プロジェクト API 設定

  9. Adobe Experience Platform を選択してリストをフィルター

  10. 使用可能な API の一覧で、「Experience PlatformAPI」を選択し、「次へ」を選択します。

    Adobe Developer Console プロジェクト API 設定

  11. 資格情報として OAuth サーバー間 を選択し、「次へ」を選択します。
    OAuth サーバー間を選択

  12. AEP-Default-All-Users 製品プロファイルを選択し、「設定済み API を保存」を選択します。

    製品プロファイルの選択

  13. これで、Developer Console プロジェクトが作成されました。

  14. ページの 試す セクションで、「Postman用にダウンロード」を選択し、「OAuth サーバー間」を選択して Postman 環境の JSON ファイルをダウンロードします。 oauth_server_to_server.postman_environment.json を Luma Tutorial Assets フォルダーに保存します。

    Adobe Developer Console プロジェクト API 設定

システム管理者に、API 資格情報を役割に追加してもらいます。

API 認証情報を使用してシステムとやり取りするには、Experience Platform管理者に、前のレッスンで作成したロールに API 認証情報を割り当てる必要があります。 システム管理者でない場合は、次のアドレスを送信します。

  1. API 資格情報の ​ 名前 ​ （Credential in Luma Tutorial API Project）

  2. 資格情報の ​ テクニカルアカウントメール ​ （これは、システム管理者が資格情報を見つけるのに役立ちます）

    資格情報の 名前 と テクニカルアカウントメール

システム管理者の手順を次に示します。

  1. Adobe Experience Platform にログインします

  2. 左側のナビゲーションで 権限 を選択すると ​ 役割 ​ 画面に移動します

  3. Luma Tutorial Platform の役割を開きます
    役割を開く

  4. 「API 資格情報」タブを選択します。

  5. 「API 資格情報を追加」を選択します。
    資格情報の追加

  6. リストが長い場合は、チュートリアル参加者から提供された ​ テクニカルアカウントメール ​ を使用してフィルタリングする、Credential in Luma Tutorial API Project しい資格情報を見つけます

  7. 認証情報の選択

  8. 「保存」を選択します

    資格情報の追加

Postmanの設定

CAUTION
Postman インターフェイスは定期的に更新されています。 このチュートリアルのスクリーンショットは、Postman v10.15.1 for Macで撮られていましたが、インターフェイスオプションが変更された可能性があります。

  1. Postman のダウンロードとインストール

  2. Postman を開き、ワークスペースを作成します
    読み込み環境

  3. ダウンロードした json 環境ファイル oauth_server_to_server.postman_environment.json を読み込みます。
    読み込み環境

  4. Postman で、ドロップダウンから環境を選択します

  5. 環境変数を表示するアイコンを選択します。

    環境の変更

サンドボックス名とテナント ID を追加

SANDBOX_NAME 変数、TENANT_ID 変数および CONTAINER_ID 変数はAdobe Developer Consoleの書き出しに含まれていないので、手動で追加します。

  1. Postman で、環境変数 を開きます。

  2. 環境名の右側にある 編集 リンクを選択します

  3. 新しい変数を追加 フィールドで、SANDBOX_NAME と入力します

  4. 両方の値フィールドに、前のレッスンでサンドボックスに付けた名前「luma-tutorial」を入力します。 サンドボックスに異なる名前（例：luma-tutorial-ignatiusjreilly）を使用した場合は、その値を使用していることを確認してください。

  5. 新しい変数を追加 フィールドで、TENANT_ID と入力します

  6. Web ブラウザーに切り替え、Experience Platformーのインターフェイスに移動して URL の部分（@記号の後 を抽出し、会社のテナント ID を検索し す。 例えば、テナント ID は techmarketingdemos ですが、現在の ID は異なります。

    Platform インターフェイス URL からのテナント ID の取得

  7. この値をコピーして、環境の管理画面 Postman 戻ります

  8. テナント ID を両方の値フィールドに貼り付けます

  9. 新しい変数を追加 フィールドで、CONTAINER_ID と入力します

  10. 両方の値フィールドに global を入力します

    note note
    NOTE
    CONTAINER_ID は、チュートリアル中に値が複数回変更されるフィールドです。 global を使用すると、API は Platform アカウントのAdobe提供の要素とやり取りします。 tenant を使用すると、API は独自のカスタム要素とやり取りします。

  11. 「保存」を選択します

    環境変数として追加された SANDBOX_NAME、TENANT_ID および CONTAINER_ID フィールド

API 呼び出しの実行

アクセストークンの取得

Adobeは、Experience Platformの API を調べるのに役立つ豊富な Postman コレクションのセットを提供します。 これらのコレクションは、Adobe Experience Platform Postman サンプル GitHub リポジトリにあります。 このリポジトリは、このチュートリアル全体で何度も使用するため、また後で自社のExperience Platformを実装する際に、ブックマークに追加する必要があります。

最初のコレクションは、AdobeIdentity Management サービス（IMS） API で動作します。 これは、Postman内からアクセストークンを取得する便利な方法です。

アクセストークンを生成するには：

  1. Identity Management サービス API コレクションを Luma Tutorial Assets フォルダーにダウンロードします

  2. コレクションの Postman への読み込み

  3. リクエスト oAuth：リクエストアクセストークン リクエストを選択し、「送信」を選択します。

  4. 応答にアクセストークンを含む 200 OK 応答が返されます。

    トークンのリクエスト

  5. アクセストークンは、Postman 環境の ACCESS_TOKEN 環境変数として自動的に保存される必要があります。

    Postman

Platform API とのインタラクション

次に、Platform API 呼び出しを実行して、すべてが正しく設定されていることを確認します。

GitHub のExperience Platform Postman コレクションを開きます。 このページには、様々な Platform API 用の多くのコレクションがあります。 ブックマークすることを強くお勧めします。

次に、最初の API 呼び出しを行います。

  1. スキーマレジストリ API コレクションを Luma Tutorial Assets フォルダーにダウンロードします
  2. Postman への読み込み
  3. スキーマレジストリ API/スキーマ/スキーマをリスト を開きます。
  4. 「パラメーター」タブと「ヘッダー」タブを見て、以前に入力した環境変数の一部がどのように含まれているかを確認します。
  5. ヘッダー/値を許可フィールド は application/vnd.adobe.xed-id+json に設定されています。 スキーマレジストリ API には、これらの 指定された Accept ヘッダー値のいずれかが必要で、応答で異なる形式を提供します。
  6. 「送信」を選択して、最初の Platform API 呼び出しを行います。

以下の図に示すように、サンドボックスでAdobeが提供する使用可能な XDM スキーマのリストを含む、200 OK 応答が成功することを願っています。

Postmanでの最初の API 呼び出し

呼び出しが成功しなかった場合は、API 呼び出しのエラー応答の詳細を使用してデバッグし、上記の手順を確認してください。 問題が発生した場合は、 コミュニティフォーラムでヘルプをリクエストするか、このページの右側にあるリンクを使用して「問題を記録」してください。

Platform の権限、サンドボックスおよび Postman を設定すると、 スキーマのデータをモデル化する準備が整います。

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad