サンドボックスツール API の概要

最終更新日: 2023-10-30
  • トピック:
  • Sandboxes
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

この開発者ガイドでは、サンドボックスツール API を使用してAdobe Experience Platformのパッケージとツールを管理する手順を説明し、様々な操作を実行するためのサンプル API 呼び出しを含んでいます。

API 呼び出し例の読み取り

ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API 応答に返されるサンプル JSON データも提供されています。 API 呼び出し例のドキュメントで使用される表記について詳しくは、『Experience Platform トラブルシューティングガイド』の API 呼び出し例の読み方に関する節を参照してください。

必要なヘッダーの値の収集

このガイドでは、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 形式、必要なヘッダーと適切な形式のペイロードを示すサンプルリクエスト、および正常な呼び 出しのサンプル応答が含まれます。

サンドボックスツール API の呼び出しを開始するには、次の API チュートリアルを参照してください。

このページ