開発者向けコンソールの設定と Postman

このレッスンでは、Adobe Developer Console でプロジェクトを設定し、 Postman プラットフォーム api を使用できるようにコレクションをダウンロードします。

このチュートリアルで API の練習を行うには、 使用しているオペレーティングシステム用の Postman app をダウンロードします。 経験 Platform Api を使用するために必要なわけではありませんが、Postman では API ワークフローを容易にします。また、Adobe エクスペリエンスプラットフォームには、API 呼び出しを実行したり、その動作を確認するための多数の Postman コレクションが用意されています。 このチュートリアルの他の部分では、Postman に関する実用的な知識があることを前提としています。 詳しくは、Postman のマニュアルを参照してください 🔗

プラットフォームは API によって最初に構築されます。 すべての主要なタスクにもインターフェイスオプションが用意されていますが、プラットフォーム API はある時点で使用することもできます。 例えば、データを取り込み、サンドボックス間でのアイテムの移動、日常的なタスクの自動化、またはユーザーインターフェイスが構築される前の新しいプラットフォーム機能の使用などを行います。

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

必要な権限

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

Adobe Developer Console の設定

  1. このチュートリアルで使用されているファイルの名前と同じフォルダーをローカルコンピューター上に作成 Luma Tutorial Assets します。

  2. Adobe Developer Console を開きます。 🔗

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

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

    新規プロジェクトを作成

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

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

  6. Adobe エクスペリエンスプラットフォームを選択してリストをフィルター処理します

  7. 使用可能な Api のリストで、「プラットフォーム API を体験」を選択し、「 ​次へ」を選択し ​ます。

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

  8. 外部システムから認証を行うには、次のように Postman 公開キーと秘密キーのペアを使用する必要があります。 新しいキーペアを作成するには、オプション1を選択して「キーペアを 生成」ボタンをクリックします。

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

  9. キーの準備が完了すると、キーをローカルマシンにダウンロードすることを求めるメッセージが表示される場合があります。 フォルダーにパッケージ化されたキーを保存 config.zip Luma Tutorial Assets します。 そのためには、次の手順を実行する必要があります。

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

     キーが生成され、選択された後の表示

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

    製品プロファイルを選択

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

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

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

    メモ

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

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

プロジェクトに番号が割り当てられている場合があります。例えば、「プロジェクト12」というように表示されます。

  1. ブレッドクラムのプロジェクト番号を選択します。

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

  3. プロジェクトの 表題 を「」に変更します (このチュートリアルを行うために Luma Tutorial API Project 企業内の他のユーザーが使用している場合は、氏名を追加します)。

  4. 保存 」ボタンを選択します。

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

Postman の設定

注意

Postman インターフェイスは、定期的に更新されます。 このチュートリアルのスクリーンショットは Postman v 9.0.5 for Mac で作成されていますが、インターフェイスオプションが変更されている場合もあります。

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

  2. Postmanダウンロードした json 環境ファイルを開いて、インポートします。service.postman_environment.json
    環境の読み込み

  3. で Postman 、ドロップダウンリストで環境を選択します。

    環境設定の変更

  4. 目の アイコンをクリック すると、環境変数が表示されます。

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

環境名の更新

開発者コンソールから書き出された環境の名前は無作為に生成されるので、実際のプラットフォーム実装での作業を開始したときに、環境を混乱させないように、わかりやすい名前を付けます。

  1. 「環境変数」ダイアログが表示されていない状態で、右上の「編集」を選択します。

  2. 環境変数の名前 を変更します。Luma Tutorial

  3. ​次の手順で編集するには、管理環境が編集モードで開いたままにしておきます。

    Postman 環境名の更新

秘密キーを追加します。

今度は、PRIVATE_KEY の値を Postman 環境に追加します。

  1. config.zipDeveloper Console プロジェクトの作成時に前の練習で生成されたダウンロードファイルを抽出します。この zip には、2つのファイルが含まれます。

    • private.key
    • certificate_pub.crt
  2. private.keyテキストエディターでファイルを開き、内容をコピーします。

  3. Postman では、前の手順で開いたままになっている > 編集環境設定を使用して 、「 初期値」 列と「 現在値」 列の PRIVATE_KEY の前にコピーした値をペーストします。

  4. 「保存」を選択します。

    Postman に貼り付けられた秘密キー

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

Adobe では、豊富なコレクションが提供されて Postman います。 これらのコレクションは、 Adobe エクスペリエンスプラットフォーム Postman サンプルの GitHub リポジトリに含まれてい ます。 このような場合は、このような場合、このリポジトリを使用して、社内用に経験プラットフォームを実装する際に、このような作業を繰り返して、このようなリポジトリを作成する必要があります。

1つ目のコレクションは、Adobe Id 管理サービス (IMS) Api と共に動作します。 これは、Postman 内で、 ** このチュートリアルをサンドボックス内で実行するような非生産目的で使用される JWT_TOKEN および ACCESS_TOKEN を設定する場合に便利です。 別の方法として、Adobe Developer Console で JWT トークンを生成することもできます。 ただし、このコレクションを使用すると、定期的に期限切れになるので、このチュートリアルを完了しても、Adobe Developer Console に再度アクセスしなくても更新できます。

警告

Adobe Identity Management Service Api README に記載されているように、この方法では、 🔗 一般に非生産用途に適しています。 ローカル署名は、サードパーティ製のホストから JavaScript ライブラリをロードします。これにより、リモート署名は、Adobe が所有している操作対象の web サービスに秘密キーを送信します。 この秘密キーは保存されませんが、製作キーは他のユーザーと共有することはできません。

トークンを生成するには、次のようにします。

  1. Developer Console Access Token Generation コレクション をフォルダーにダウンロードします Luma Tutorial Assets

  2. コレクションをに読み込み Postman

  3. IMS: JWT の生成」を選択し、「 送信」を選択します。

    トークンの要求

  4. の環境変数には、JWT_TOKEN および ACCESS_TOKEN が自動的に挿入され Postman ます。

    Postman

サンドボックス名およびテナント ID を追加します。

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

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

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

  3. 「新規変数の追加」フィールドに 「」と入力します。SANDBOX_NAME

  4. 両方の値フィールドには、 luma-tutorial 前のレッスンでサンドボックスに付けた名前を入力します。 サンドボックスに別の名前を使用した場合 (例えば、ignatiusjreilly)、その値を使用しているかどうかを確認してください。

  5. 「新規変数の追加」フィールドに 「」と入力します。TENANT_ID

  6. Web ブラウザーに切り替えて、プラットフォームのインターフェイスを使用して URL の一部を @ 記号の後に展開することによって、会社のテナント id を検索し ** ます。 例えば、my テナント id は、 techmarketingdemos 次のようには異なります。

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

  7. この値をコピーして「 Postman 環境の管理」画面に戻る

  8. テナント id と値フィールドの両方をペースト

  9. 「新規変数の追加」フィールドに 「」と入力します。CONTAINER_ID

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

    メモ

    CONTAINER_ID は、チュートリアル中に値が数回変更されているフィールドです。 globalを使用すると、プラットフォームアカウントで Adobe 提供のエレメントを使用して API が操作されます。を使用すると、 tenant API は独自のカスタムエレメントとやり取りします。

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

    環境変数として追加されたフィールドを SANDBOX_NAME、TENANT_ID、CONTAINER_ID します。

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

ここで、プラットフォーム API 呼び出しを作成して、すべての設定が正しく構成されていることを確認します。

GitHub で経験プラットフォーム Postman コレクションを開き ます。このページには、多種多様なプラットフォーム Api 用のコレクションが数多くあります。 ブックマークをブックマークにすることを強くお勧めします。

次に、最初の API 呼び出しについて説明します。

  1. 作成した フォルダーに、スキーマレジストリ API コレクションをダウンロードします。 Luma Tutorial Assets
  2. に読み込む Postman
  3. スキーマレジストリ API > クラス > 指定されたコンテナ内のクラスのリストを取得します。
  4. Params 」タブと「ヘッダー」タブでは、前の手順で入力し ​た環境変数がどのように含まれているかを確認してください。
  5. ヘッダー > Accept value」フィールド はに設定されていることに注意 application/vnd.adobe.xed-id+json してください。 スキーマのレジストリ Api には、 🔗 応答に異なるフォーマットを提供するために、指定された Accept ヘッダ値のいずれかが必要です。
  6. ​最初のプラットフォーム API 呼び出しを行うには、「送信」を選択します。

200 OK次の図に示すように、サンドボックスで使用できる標準の XDM クラスのリストを含む応答が成功した場合は、

Postman の1番目の API 呼び出し

呼び出しに失敗した場合は、API 呼び出しのエラー応答の詳細を使用してデバッグし、上記の手順を確認してください。 問題が発生した場合は、Community フォーラムでヘルプを依頼してください 🔗 。または、このページの右側にあるリンクを使用して「問題のログを作成」を選択します。

その他のリソース

プラットフォームアクセス許可、サンドボックス、および Postman 設定を使用すると、 スキーマでデータをモデル化することができ ます。

このページ