ベータ版
セルフサービスソースの概要(ストリーミングSDK)
作成対象:
- 開発者
セルフサービスソース(ストリーミング SDK)を使用すると、独自のソースを統合してストリーミングデータをAdobe Experience Platformに取り込むことができます。 このドキュメントでは、Flow Service API を呼び出す前に知っておく必要があるコア概念の概要を説明します。
プロセスの概要
Experience Platformでソースを設定する手順の概要を次に示します。
統合
ドキュメント
- ソースのドキュメント化を開始するには、 セルフサービスソースのドキュメント作成の概要を参照してください。
- GitHub を使用してドキュメントを作成する手順については、GitHub web インターフェイスの使用に関するガイドを参照してください。
- ローカルマシンを使用してドキュメントを作成する手順については、 テキストエディターの使用に関するガイドを参照してください。
- ストリーミング SDK API ドキュメントテンプレートを使用して、API にソースをドキュメント化する。
- ストリーミング SDK UI ドキュメントテンプレートを使用して、UI にソースをドキュメント化します。
以下のドキュメントテンプレートもダウンロードできます。
前提条件
セルフサービスソース(ストリーミング SDK)を使用するには、Adobe Experience Platform ソースでプロビジョニングされたサンドボックス組織にアクセスできる必要があります。
このガイドには、Adobe Experience Platformの次のコンポーネントに関する十分な知識も必要です。
API 呼び出し例の読み取り
セルフサービスソース(ストリーミング SDK)と Flow Service 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}
Flow Service に属するリソースを含む、Experience Platformのすべてのリソースは、特定の仮想サンドボックスに分離されます。 Experience Platform API へのすべてのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。
x-sandbox-name: {SANDBOX_NAME}
ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、次のような追加ヘッダーが必要です。
Content-Type: application/json
次の手順
セルフサービスソース(ストリーミングSDK)を使用して新しいソースの作成を開始するには、 新しいソースの作成に関するチュートリアルを参照してください。