概念
このAPIはRoktネットワーク上で構築する統合パートナー向けです。Roktのeコマースパートナーで、自社のチェックアウトに配置を統合する場合は、代わりにRokt Ecommerce開発者ドキュメントを使用してください。
Partnerships APIの範囲は小さいですが、いくつかの概念が各エンドポイントの動作を形作ります。これらは統合を行う前に一度読んでください。再試行、置換対パッチセマンティクス、非同期書き込み、タクソノミーの変換、そしてサーフェスがマーチャントのページ上でSDK呼び出しにどのようにマッピングされるかを管理する契約です。
推奨される読み順推奨される読み順 への直接リンク
エンドツーエンドで統合する場合は、順番に進めてください。初期の概念は後の概念の前提条件です。例えば、登録およびコントロールフローで行うすべての書き込みには冪等性キーが必要であり、ポーリングが必要な操作IDが表示されることがあります。
あなたのプラットフォームはマネージャーであり、オンボードするマーチャントは管理されたアカウントです。最初の認証済みコールを行う前に読んでください。
すべての書き込みには Idempotency-Key が必要です。同じキー、同じレスポンスなので、再試行しても安全です。APIの残りはそれを前提としています。
コントロールエンドポイント(MCL、ステータス)はPUT-リプレースであり、PATCHではありません。毎回、望む状態全体を送信してください。最初のコントロール更新の前に読んでください。
dry_run=true は完全な検証を実行し、状態を保持せずに想定されるレスポンスを返します。本番環境に移行する前にペイロードを検証する際に読んでください。
書き込みは X-Operation-Id を返します。レスポンスを失った書き込みの結果を回復するために使用します。冪等性を理解したら読んでください。
パートナーの分類法で垂直をブロックします。Roktはサーバー側で翻訳します。マーケットプレイスコントロールを構築し始めたら読んでください。
サーフェス(確認、追跡、返品)が page_identifier にどのようにマップされ、V1テーマPATCHがどのように機能するか。SDK統合の前に読んでください。
ネットワークオプトアウト、ネットワークデータ削除、および管理アカウントデータ削除。プライバシーリクエストフローを追加する際に読んでください。