Developer ConsoleとPostmanのセットアップ

このレッスンでは、Adobeデベロッパーコンソールにプロジェクトを設定し、Postmanコレクションをダウンロードして、プラットフォームAPIを使用して開始できるようにします。

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

プラットフォームはAPIから構築されます。 すべての主要なタスクに対してインターフェイスオプションも存在しますが、いつかPlatform APIを使用することをお勧めします。 例えば、データを取り込むには、サンドボックス間をアイテムを移動し、ルーチンタスクを自動化するか、UIが構築される前に新しいプラットフォーム機能を使用します。

データ アーキテクチャと データ エンジニアは、このチュートリアル以外でプラットフォームAPIを使用する必要がある場合があります。

必要な権限

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

  • 権限項目サンドボックス> Luma Tutorial
  • Luma Tutorial Platform製品プロファイルへの開発者ロールのアクセス

Adobe開発者コンソールの設定

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

  2. Adobe開発者コンソールを開きます

  3. ログインし、正しい組織であることを確認します。

  4. クイック開始メニューの「新しいプロジェクト​を作成」ボタン​をクリックします。

    新規プロジェクトを作成

  5. 新しく作成したプロジェクトで、「プロジェクトへ追加」ボタンをクリックし、「API」を選択します

    Adobe開発者コンソールプロジェクトAPIの設定

  6. Adobe Experience Platform​をクリックしてリストをフィルターします

  7. 使用可能なAPIのリストで、Experience PlatformAPI​を選択し、次へ​をクリックします。

    Adobe開発者コンソールプロジェクトAPIの設定

  8. Postmanのような外部システムからの認証には、公開鍵と秘密鍵のペアが必要です。 新しいキーペアを生成するには、オプション1​を選択し、キーペアを生成​ボタンを押します

    Adobe開発者コンソールプロジェクトAPIの設定

  9. キーの準備が整ったら、ローカルマシンにキーをダウンロードするように求められる場合があります。 config.zipにパッケージ化されたキーをフォルダーLuma Tutorial Assetsに保存します。 次の練習で必要になります。

  10. キーが生成されると、スクリーンショットに示すように公開鍵がプロジェクトに自動的に追加されます。 「次へ」ボタンをクリックします。

     キーの生成後の表示と選択

  11. Luma Tutorial Platform製品プロファイルを選択し、「設定済みAPIを保存」ボタンをクリックします

    製品プロファイルを選択

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

  13. ページの​​試す」セクションで、「Postman用にダウンロード」をクリックし、「サービスアカウント(JWT)」をクリックしてPostman環境jsonファイルをダウンロードします。 service.postman_environment.jsonLuma Tutorial Assetsフォルダーに保存します。

    Adobe開発者コンソールプロジェクトAPIの設定

    メモ

    組織のシステム管理者は、Admin Consoleの製品プロファイルでプロジェクトを「統合」として表示できます。

    Adobe開発者コンソールプロジェクトAPIの設定

プロジェクトに番号が割り当てられていることに気付いたかもしれません(例:"プロジェクト12":

  1. 階層リンクでプロジェクト番号をクリックします

  2. プロジェクトを編集」ボタンをクリックします

  3. プロジェクトのタイトル​をLuma Tutorial API Projectに変更します(会社の複数の人がこのチュートリアルを受ける場合は、最後に自分の名前を追加します)

  4. 保存」ボタンをクリックします。

    Adobe開発者コンソールプロジェクトAPIの設定

郵便配達員の設定

  1. Postmanをダウンロードしてインストール

  2. Postmanを開き、ダウンロードしたJSON環境ファイルservice.postman_environment.jsonを読み込みます
    Adobe開発者コンソールの読み込み環境

  3. Postmanで、右上のドロップダウンで環境を選択し、eye​アイコンをクリックして環境変数を表示します。 ACCESS_TOKEN、PRIVATE_KEY、JWT_TOKEN変数は空白であることがわかります。

    Adobe開発者コンソールプロジェクトAPIの設定

環境名の更新

Developer Consoleから書き出した環境の名前はランダムに生成されるので、後で実際のプラットフォームの実装を開始する際に環境を混乱させないように、わかりやすい名前を付けておきます

  1. 環境変数画面が開いたままの状態で、右上の「編集」をクリックします

  2. 環境名​をLuma Tutorialに更新

  3. 環境の管理​モーダルを編集モードで開いたままにします。次の手順でさらに編集します

    Postman環境名の更新

秘密鍵追加

次に、Postman環境にPRIVATE_KEY値を追加します。

  1. ダウンロードしたconfig.zipファイルを抽出します。このファイルは、前の練習で生成したもので、Developer Console Projectの作成時に作成したものです。 これには、次の2つのファイルが含まれます。
    • private.key
    • certificate_pub.crt
  2. private.keyファイルをテキストエディターで開き、使用可能なすべてのコンテンツをコピーします。
  3. Postmanの場合、前の練習でまだ開いている​環境を管理/モーダルを編集​に、初期値​列と​現在値​列の​PRIVATE_KEY​の前にコピーした値を貼り付けます。.
  4. 更新」ボタンをクリックして、PRIVATE_KEYと更新した環境名を保存します。
    秘密鍵を郵便番号に貼り付けました

JWT追加とアクセストークン

Adobeは、Experience PlatformのAPIを調べるのに役立つ豊富なPostmanコレクションのセットを提供します。 これらのコレクションは、GitHubリポジトリAdobe Experience Platformポストマンサンプルにあります。 このレポートは、このチュートリアルを通して何度も使用するので、ブックマークを付けてください。後で、独自の会社にExperience Platformを導入する際に使用します。

最初のコレクションは、AdobeIdentity Managementサービス(IMS)APIと連携します。 JWT_TOKENとACCESS_TOKENをPostman 内から入力する便利な方法で、実稼働以外の使用例​に対してサンドボックスでの入力などを意図しています。 また、JWTトークンはAdobe開発者コンソール内で生成できますが、定期的に期限が切れるので、このコレクションを使用して更新すれば、このチュートリアルを完了する際に、Adobe開発者コンソールに再度アクセスする必要はありません。

警告

Adobe I/Oアクセストークン生成ポストマンコレクションREADMEに記載されているように、表記された生成方式は非実稼働での使用に適しています。 ローカル署名では、サードパーティのホストからJavaScriptライブラリが読み込まれ、リモート署名では、所有および操作されるWebサービスがAdobeに秘密鍵を送信します。 Adobeはこの秘密鍵を保存しませんが、プロダクションキーを他のユーザーと共有することは避けてください。

トークンを生成するには:

  1. Developer Consoleアクセストークン生成コレクションLuma Tutorial Assetsフォルダーにダウンロードします

  2. コレクションをPostmanにインポート

  3. リクエスト​IMSを選択します。JWT Generate + Auth via User Token​をクリックし、「Send」をクリックします。

    トークンのリクエスト

  4. JWT_TOKEN​と​ACCESS_TOKEN​は、Postmanの環境変数に自動入力されます。

    郵便配達人

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

SANDBOX_NAME変数とTENANT_ID変数とCONTAINER_ID変数は、Adobe開発者コンソールからの環境エクスポートでは提供されないので、手動で追加します。

  1. Postmanで、環境変数​モーダルを開きます。

  2. 環境名の右にある​編集​リンクをクリックします

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

  4. 両方の値フィールドに、前のレッスンでSandboxに与えた名前luma-tutorialと入力します。 サンドボックスに別の名前( luma-tutorial-ignatiusjreilly、必ずこの値を使用してください。

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

  6. Webブラウザーに切り替え、Experience Platformのインターフェイスに移動し、@記号​の後に URLの一部を抽出して、会社のテナントIDを検索します。 例えば、私のテナントIDはtechmarketingdemosですが、あなたのテナントIDは何か別のものになります。

    プラットフォームインターフェイスURLからのテナントIDの取得

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

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

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

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

    メモ

    CONTAINER_ID は、このチュートリアルの間に値を何度か変更するフィールドです。globalを使用すると、APIはプラットフォームアカウント内のAdobe提供の要素とやり取りします。 tenantを使用すると、APIは独自のカスタム要素とやり取りします。

  11. 更新」ボタンをクリックして、変数を保存します

    SANDBOX_NAME、TENANT_ID、コンテナIDの各フィールドが環境変数として追加されました

「環境の管理」モーダルを閉じることができるようになりました。

プラットフォームAPI呼び出しの作成

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

GithubのPostmanexperience-platform-postman-samples🔗にあるExperience Platformの別のグループを開きます。 このページには様々なプラットフォーム機能に関連した多数のコレクションがあります。

このチュートリアルで必要となるコレクションをダウンロードします。 このGithubリポジトリは、会社に対するプラットフォームの実装を開始する際に、このチュートリアルの終了後に非常に役立つものとなるので、ブックマークを設定することを強くお勧めします。

では、最初のAPI呼び出しを行います。

  1. スキーマレジストリAPIコレクションLuma Tutorial Assetsフォルダーにダウンロードします
  2. Postmanにインポート
  3. スキーマレジストリAPI >クラス>指定したコンテナのすべてのクラスをリスト​を開きます。
  4. Params」タブと「Headers」タブを見て、前に入力した環境変数の一部がこれらに含まれていることを確認してください。
  5. ヘッダー/値を受け入れるフィールド​をクリックし、application/vnd.adobe.xed-id+jsonに変更します。 スキーマレジストリAPIでは、応答に異なる形式を提供する指定されたのいずれかを受け入れる必要があります。
  6. 「Send」ボタンをクリックして、最初のプラットフォームAPI呼び出しを行います。

以下の図のように、サンドボックス内の標準XDMクラスのリストを含む200 OKの応答が成功したことを願います。

Postmanでの最初のAPI呼び出し

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

その他のリソース

プラットフォームの権限、サンドボックス、Postmanの設定が完了したら、スキーマ🔗のモデルデータを使用する準備が整いました。

このページ