開発者コンソールの設定および Postman

最終更新日: 2023-06-23
  • トピック:
  • API
    このトピックの詳細を表示
  • 作成対象:
  • Beginner
    Intermediate
    Developer

このレッスンでは、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コンソールは、AdobeAPI および SDK へのアクセス、ほぼリアルタイムのイベントのリッスン、Runtime での関数の実行、App Builder アプリケーションの構築をおこなう開発者の宛先です。 この変数を使用してExperience PlatformAPI にアクセスします。 詳しくは、 Adobe Developer Console ドキュメント

  1. ローカルマシン上に、という名前のフォルダーを作成します。 Luma Tutorial Assets 」を参照してください。

  2. を開きます。 Adobe Developer Console

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

  4. 選択 新規プロジェクトを作成 in クイックスタート メニュー

    新規プロジェクトを作成

  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. これで、開発者コンソールプロジェクトが作成されました。

  14. 試す 「 」セクションで、「 」を選択します。 Postman用のダウンロード 次に、 OAuth サーバー間 をダウンロードするには Postman 環境 json ファイル。 保存する oauth_server_to_server.postman_environment.jsonLuma 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. 選択 権限 左側のナビゲーションで、 役割 screen

  3. を開きます。 Luma Tutorial Platform 役割
    ロールを開く

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

  5. 選択 API 資格情報を追加
    資格情報を追加

  6. 次を検索: Credential in Luma Tutorial API Project 秘密鍵証明書、フィルタリング テクニカルアカウントの電子メール リストが長い場合は、チュートリアル参加者が提供します。

  7. 秘密鍵証明書を選択

  8. 保存」を選択します

    資格情報を追加

Postmanの設定

注意

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

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

  2. 開く Postman ワークスペースの作成
    環境のインポート

  3. ダウンロードした JSON 環境ファイルをインポートします。 oauth_server_to_server.postman_environment.json
    環境のインポート

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

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

    環境の変更

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

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

  1. In Postman、 環境変数

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

  3. 新しい変数フィールドを追加​を入力して、 SANDBOX_NAME

  4. 両方の値フィールドに、 luma-tutorial:前のレッスンでサンドボックスに付けた名前。 サンドボックスに別の名前(例:luma-tutorial-ignatiusjreilly)を使用した場合は、必ずその値を使用してください。

  5. 新しい変数フィールドを追加​を入力して、 TENANT_ID

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

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

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

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

  9. 新しい変数フィールドを追加​を入力して、 CONTAINER_ID

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

    メモ

    CONTAINER_ID は、チュートリアルの間に値が複数回変更されるフィールドです。 条件 global が使用されている場合、API は Platform アカウント内でAdobeが指定した要素とやり取りします。 条件 tenant が使用されている場合、API は独自のカスタム要素とやり取りします。

  11. 保存」を選択します

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

API 呼び出しの実行

アクセストークンの取得

Adobeは、 Postman コレクションを参照してください。Experience Platformの API を調べるのに役立ちます。 これらのコレクションは、 Adobe Experience Platform Postmanのサンプル GitHub リポジトリ. このチュートリアル全体でこのを何度も使用するので、後で独自の会社にExperience Platformを実装する際には、このリポジトリをブックマークする必要があります。

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

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

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

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

  3. リクエストを選択 oAuth:アクセストークンをリクエスト リクエストと選択 送信

  4. 以下を受け取る必要があります。 200 OK レスポンスにアクセストークンを含むレスポンス

    トークンのリクエスト

  5. アクセストークンは、 ACCESS_TOKEN 環境変数 Postman 環境。

    Postman

Platform API の操作

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

を開きます。 Experience Platform Postman GitHub のコレクション. 様々な 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 呼び出しをおこないます。

うまくいけば 200 OK 次の図に示すように、サンドボックス内で使用可能なAdobe提供の XDM スキーマのリストを含む応答。

Postmanでの最初の API 呼び出し

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

Platform の権限、サンドボックス、 Postman を設定し、 スキーマ内のモデルデータ!

このページ