API キーはどこで入手できますか?

API キーは、すべての API リクエストのヘッダーとして必要です。これは、Adobe Developer Console から入手できます。コンソールの「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下にキーが表示されます。Experience Platform への認証方法の詳しい手順については、認証に関するチュートリアルを参照してください。

アクセストークンはどのように入手できますか?

アクセストークンは、すべての API 呼び出しの Authorization ヘッダーに必要です。組織の統合にアクセスできる場合は、CURL コマンドを使用して生成できます。アクセストークンは 24 時間のみ有効で、その後 API を使用し続けるためには新しいトークンを生成する必要があります。アクセストークンの生成について詳しくは、認証に関するチュートリアルを参照してください。

クエリーパラメーターの使用方法

一部の Experience Platform API エンドポイントは、クエリパラメーターを受け取って特定の情報を検索し、応答で返される結果をフィルタリングします。リクエストパスに疑問符(?)記号が付加され、その後に 1 つ以上のクエリーパラメーターが paramName=paramValue 形式で追加されます。1 回の呼び出しで複数のパラメーターを組み合わせる場合、アンパサンド(&)を使用して個々のパラメーターを区切る必要があります。次の例は、複数のクエリーパラメーターを使用するリクエストがドキュメントでどのように表現されているかを示しています。

以下は、一般的に使用されるクエリーパラメーターの例です。

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

特定のサービスまたはクエリで使用できるエンドポイントパラメーターの詳細については、サービス固有のドキュメントを参照してください。

PATCH リクエストで更新する JSON フィールドを指定する方法を教えてください。

Experience Platform API の多くの PATCH 操作では、JSON Pointer 文字列を使用して、更新する JSON プロパティを示します。これらは通常、JSON パッチ 形式を使用してリクエストペイロードに含まれます。これらのテクノロジーに必要な構文について詳しくは、API の基本原則ガイドを参照してください。

Postman を使用して Experience Platform API を呼び出すことはできますか?

Postman は、RESTful API への呼び出しを視覚化する便利なツールです。Experience Platform API 入門ガイドには、Postman コレクションを読み込むためのビデオと手順が含まれています。 さらに、各サービスについて Postman コレクションのリストが提供されます。