Adobe Experience Platform API の概要

Adobe Experience Platformは、「API ファースト」の理念の下に開発されています。 Experience Platform API を使用すると、計算済み属性の設定、データやエンティティへのアクセス、データのエクスポート、不要なデータやバッチの削除など、データに対する基本的な CRUD （作成、読み取り、更新、削除）操作をプログラムで実行できます。

各Experience Platform サービスの API はすべて認証ヘッダーのセットを共有し、CRUD 操作に同様の構文を使用します。 次のガイドでは、Experience Platform API の使用を開始するために必要な手順の概要を説明します。

認証とヘッダー

Experience Platform エンドポイントを正常に呼び出すには、​ 認証チュートリアル ​ を完了する必要があります。 次に示すように、Experience Platform API 呼び出しの必要な各ヘッダーの値は、認証に関するチュートリアルで説明されています。

サンドボックスヘッダー

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。Experience Platform API へのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。

Experience Platform のサンドボックスについて詳しくは、サンドボックスの概要ドキュメ ントを参照してください。

Content-type ヘッダー

リクエスト本文にペイロードを持つすべてのリクエスト（POST、PUT、PATCH 呼び出しなど）には、Content-Type ヘッダーが含まれている必要があります。指定できる値は、各 API エンドポイントによって異なります。 エンドポイントに特定の Content-Type 値が必要な場合、その値は、​ 個々のExperience Platform サービスの API ガイド ​ によって提供される API リクエストの例に表示されます。

Experience Platform API の基本事項

Adobe Experience Platform API では、Experience Platform リソースを効果的に管理するために理解しておくべき、いくつかの基本的なテクノロジーおよび構文を使用します。

JSON スキーマオブジェクトの例など、Experience Platformが利用する基盤となる API テクノロジーについて詳しくは、Experience Platform API の基礎 ​ ガイドを参照してください。

Experience Platform API 用のPostman コレクション

Postmanは、API 開発のコラボレーションプラットフォームで、プリセット変数の設定、API コレクションの共有、CRUD リクエストの効率化などを行うことができます。 ほとんどのExperience Platform API サービスには、API 呼び出しの実行を支援するために使用できるPostman コレクションがあります。

環境の設定方法、使用可能なコレクションのリスト、コレクションの読み込み方法など、Postmanについて詳しくは、Experience Platform Postmanのドキュメント ​ を参照してください。

API 呼び出し例の読み取り sample-api

リクエストの形式は、使用するExperience Platform API によって異なります。 API 呼び出しの構造を学ぶ最善の方法は、使用している特定のExperience Platform サービスのドキュメントに記載されている例に従うことです。

Experience Platform のドキュメントは、2 つの異なる方法での API 呼び出しの例を示しています。 まず、呼び出しは API 形式 ​で表されます。これは、操作（GET、POST、PUT、PATCH、DELETE など）と使用中のエンドポイント（例えば、/global/classes）のみを示すテンプレート表現です。また、テンプレートには、GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} などの呼び出しの作成方法を示すために、変数の位置を示すものもあります。

その後、呼び出しは、リクエスト ​内の cURL コマンドとして表示されます。これには、API とのやり取りに必要なヘッダーと完全な「ベースパス」が含まれます。ベースパスは、すべてのエンドポイントの前に追加する必要があります。例えば、前述の /global/classes エンドポイントは https://platform.adobe.io/data/foundation/schemaregistry/global/classes になります。ドキュメント全体で API 形式/リクエストパターンが表示され、Experience Platform API に対して独自の呼び出しを行う際に、リクエスト例に示されている完全パスを使用することが想定されます。

API リクエストの例

以下は、ドキュメントで使用される形式を示す API リクエストの例です。

API 形式

API 形式は、操作（GET）と使用されているエンドポイントを示します。変数は中括弧で示されます（この場合は {CONTAINER_ID}）。

GET /{CONTAINER_ID}/classes

リクエスト

この例のリクエストでは、API 形式の変数には、リクエストパス内の実際の値が与えられます。さらに、必要なすべてのヘッダーは、サンプルヘッダー値または機密情報（セキュリティトークンやアクセス ID など）を含める必要がある変数として表示されます。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

この応答は、送信されたリクエストに基づいて、API の呼び出しが成功した後に何を受け取るかを示します。場合によっては、応答がスペースを節約するために切り捨てられいるため、サンプルに表示されている情報に加えて他の情報が表示されることがあります。

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

エラーメッセージ

Experience Platform トラブルシューティングガイド ​ には、Experience Platform サービスの使用時に発生する可能性のあるエラーのリストが記載されています。

個々のExperience Platform サービスのトラブルシューティングガイドについては、​ サービストラブルシューティングディレクトリ ​ を参照してください。

必要なヘッダーやリクエスト本文など、Experience Platform API の特定のエンドポイントについて詳しくは、Experience Platform API ガイド ​ を参照してください。

Experience Platform API ガイド api-guides

各サービスで使用できる特定のエンドポイントと操作について詳しくは、Adobe I/Oの API リファレンスドキュメント ​ を参照してください。

次の手順

このドキュメントでは、必要なヘッダー、使用可能なガイドを紹介し、API 呼び出しの例を示しました。 Adobe Experience Platformで API 呼び出しを行うために必要なヘッダー値が揃ったので、参照する API エンドポイントを Experience Platform API ガイド テーブル ​ から選択します。

よくある質問への回答については、Experience Platform トラブルシューティングガイド ​ を参照してください。

Postman環境を設定し、使用可能なPostman コレクションを調べるには、Experience Platform Postman ガイド ​ を参照してください。