サンドボックス API - はじめに
Adobe Experience Platform のサンドボックスは、独立した開発環境を提供し、本番環境に影響を与えることなく、機能のテスト、実験の実行、カスタム設定を行うことができます。
この開発者ガイドでは、サンドボックス API を使用して Experience Platform のサンドボックスを管理する手順を説明し、様々な操作を実行するための API 呼び出し例を含んでいます。
前提条件
組織のサンドボックスを管理するには、サンドボックス管理権限が必要です。 アクセス権限のないユーザーは、現在のユーザーのアクティブなサンドボックスを一覧表示するために、利用可能なサンドボックスエンドポイント のみを使用できます。 Experience Platform のサンドボックス権限を割り当てる方法について詳しくは、「アクセス制御の概要」を参照してください。
API 呼び出し例の読み取り
ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。 また、API レスポンスで返されるサンプル JSON も示されています。 API 呼び出し例のドキュメントで使用される表記について詳しくは、『Experience Platform トラブルシューティングガイド』の API 呼び出し例の読み方に関する節を参照してください。
必須ヘッダーの値の収集
このガイドでは、Experience Platform APIの呼び出しを正常に行うには、認証チュートリアル を完了する必要があります。 認証に関するチュートリアルを完了すると、すべての Experience Platform API 呼び出しで使用する、以下のような各必須ヘッダーの値が提供されます。
- Authorization: Bearer
{ACCESS_TOKEN} - x-api-key：
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
認証ヘッダーに加えて、すべてのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。
- x-sandbox-name:
{SANDBOX_NAME}
ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、次の追加のヘッダーが必要です。
- Content-Type: application/json
次の手順
必要な資格情報を収集したので、開発者ガイドの残りをお読みください。 各節では、エンドポイントに関する重要な情報を提供し、CRUD 操作を実行するための API 呼び出しの例を示します。 各呼び出しには、一般的な API 形式、必要なヘッダーと適切な形式のペイロードを示すサンプルリクエスト、および正常な呼び 出しのサンプル応答が含まれます。