Identity Service API ガイド
Adobe Experience Platform Identity Serviceは、Adobe Experience Platform内のID グラフと呼ばれるもので、クロスデバイス、クロスチャネル、およびほぼリアルタイムの顧客のIDを管理します。
はじめに
このガイドを利用するには、Adobe Experience Platform の次のコンポーネントについて実用的な理解が必要です。
- Identity Service：顧客プロファイルデータの断片化がもたらす基本的な課題を解決します。 これは、顧客が企業と接触するデバイスやシステムをまたいでIDを橋渡しすることで実現します。
- Real-Time Customer Profile：複数のソースからの集約データに基づいて、統合された消費者プロファイルをリアルタイムで提供します。
- Experience Data Model (XDM)：Experience Platform が、カスタマーエクスペリエンスデータを整理する際に使用する、標準化されたフレームワーク。
次の節では、Identity Service APIの呼び出しを正常に行うために知っておく必要がある、または手元にある必要がある追加情報を示します。
API 呼び出し例の読み取り
ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。 また、API レスポンスで返されるサンプル JSON も示されています。 ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーの値の収集
Experience Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。 次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
- Authorization: Bearer
{ACCESS_TOKEN} - x-api-key：
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。 Experience Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。
- x-sandbox-name：
{SANDBOX_NAME}
ペイロード（POST、PUT、PATCH）を含んだすべてのリクエストには、以下の追加ヘッダーが必要です。
- Content-Type: application/json
地域ベースのルーティング
Identity Service APIは、リクエストパスの一部として{REGION}を含める必要がある地域固有のエンドポイントを使用します。 組織のプロビジョニング中に、地域が決定され、組織プロファイル内に保存されます。 各エンドポイントで正しい領域を使用すると、Identity Service APIを使用して行われたすべてのリクエストが適切な領域にルーティングされます。
現在、Identity Service個のAPIでサポートされているリージョンは、VA7とNLD2の2つです。
次の表に、地域を使用したパスの例を示します。
組織プロファイル内に地域が見つからない場合は、システム管理者に連絡してサポートを受けてください。
Identity Service APIの使用
これらのサービスで使用される ID パラメーターは、次の 2 つの方法、複合または XID のいずれかで表現できます。
複合 ID は、ID 値と名前空間の両方を含む構成です。 複合 ID を使用する場合、名前空間は名前（namespace.code）または ID（namespace.id）で指定できます。
IDが保持されると、Identity ServiceはそのIDを生成し、ネイティブ IDまたはXIDと呼ばれるIDにそのIDを割り当てます。 クラスター API とマッピング API のすべてのバリエーションは、リクエストと応答で複合 ID と XID の両方をサポートしています。 これらのAPIを使用するには、次のパラメーターのいずれかが必要です。xid、[nsまたはnsid]およびidの組み合わせ。
応答のペイロードを制限するため、API は、使用される ID 構文のタイプに応じて、それらの応答を調整します。 つまり、XID を渡すと応答に XID が含まれ、複合 ID を渡すと、応答はリクエストで使用される構造に従います。
このドキュメントの例では、Identity Service APIの完全な機能を説明していません。 完全な API については、「Swagger API リファレンス」を参照してください。
次の手順
必要な資格情報を収集したので、開発者ガイドの残りをお読みください。 各節では、エンドポイントに関する重要な情報を提供し、CRUD 操作を実行するための API 呼び出しの例を示します。 各呼び出しには、一般的な API 形式、必要なヘッダーと適切な形式のペイロードを示すサンプルリクエスト、および正常な呼び 出しのサンプル応答が含まれます。