Adobe Experience Platform API の概要

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

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

認証とヘッダー

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

• Authorization: Bearer {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {ORG_ID}

サンドボックスヘッダー

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

• x-sandbox-name: {SANDBOX_NAME}

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

Content-type ヘッダー

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

Experience Platform API の基本

Adobe Experience Platform API は、Platform リソースを効果的に管理するために理解する必要がある、基盤となる複数のテクノロジーと構文を使用しています。

JSON スキーマオブジェクトの例など、Platform が利用する基になる API テクノロジーの詳細については、 Experience PlatformAPI の基本 ガイド。

Experience PlatformAPI 用のPostmanコレクション

Postmanは、API 開発のコラボレーションプラットフォームで、プリセット変数を使用して環境を設定し、API コレクションを共有し、CRUD リクエストを合理化するなどのことができます。 ほとんどの Platform API サービスにはPostmanコレクションがあり、API 呼び出しの実行に役立ちます。

環境の設定方法、使用可能なコレクションのリスト、コレクションの読み込み方法など、Postmanについて詳しくは、 Platform Postman documentation.

API 呼び出し例の読み取り

リクエストの形式は、使用する Platform API によって異なります。API 呼び出しの構造を学ぶ最善の方法は、使用している特定の 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 形式/リクエストパターンはドキュメント全体で確認できます。独自で 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": {}
}

エラーメッセージ

この Platform トラブルシューティングガイド は、任意のエラーサービスを使用する際に発生する可能性のあるExperience Platformのリストを提供します。

個々の Platform サービスのトラブルシューティングガイドについては、 サービストラブルシューティングディレクトリ.

必要なヘッダーやリクエスト本文を含む、Platform API の特定のエンドポイントについて詳しくは、 Platform API ガイド.

Platform API ガイド

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

次の手順

このドキュメントでは、必要なヘッダー、利用可能なガイド、API 呼び出しの例を紹介しました。 Adobe Experience Platformで API 呼び出しをおこなうために必要な必須のヘッダー値が揃ったので、 Platform API ガイドの表.

よくある質問に対する回答については、 Platform トラブルシューティングガイド.

Postman環境を設定し、使用可能なPostmanコレクションを確認するには、 Platform Postmanガイド.

Business.Adobe.com リソース