OCAPI の利用方法 23.1
Open Commerce API の使用に関する詳細な情報:
トピック | 説明 |
---|---|
API Explorer | API Explorer を使用すると、Open Commerce API をインタラクティブに探索できます。 |
バッチリクエスト | 場合によっては、複数の独立したリクエストを発行する代わりに、バッチリクエスト (最高で 50 件のサブリクエストを含めることのできるマルチパート HTTP リクエスト) を使用できます。 |
ベストプラクティス | OCAPI を使用する上で役立つ情報。 |
キャッシング | クライアント側にアプリケーションキャッシュを構築するか、プロキシキャッシュを利用できます。 |
クライアントアプリケーションの識別 | セキュリティと追跡のために、クライアントアプリケーションが自分自身を確実に識別するようにする必要があります。 |
CORS | CORS (Cross-Origin Resource Sharing) を利用できます。 |
カスタムプロパティ | ビスネスオブジェクトの顧客プロパティにアクセスできます。 |
カスタマイズ | サーバー側で OCAPI リソースをカスタマイズできます。 |
データ形式 | リソースに希望するデータ形式を指定できます (JSON または XML)。 |
展開 | 展開という技法を使用して、ネットワークトラフィックを最小限に抑え、サーバー CPU の利用率を節減することができます。 |
フィルター | API リクエストにフィルターを指定して、レスポンス内の品目数を制限できます。 |
Flash | スペシャル情報を含むドキュメント。 |
グローバル例外 | OCAPI によってスローされたグローバル例外。 |
グローバル HTTP ヘッダー | OCAPI によってグローバルに使用される HTTP ヘッダー。 |
フックのサーキットブレーカー | フックのサーキットブレーカー機能は、フックのエラー率が上がったときにシステムを保護するので、安定性が高まり、処理時間が短縮されます。 |
HTTP メソッド | 標準の HTTP メソッド (RFC2616 によって定義) に基づいてリクエストを作成できます。 |
HTTP ステータスコードとフォールト | HTTP ステータスコードとフォールトを検討することで、問題や失敗を診断できます。 |
画像 | 絶対 URL を使用して画像を取得できます。 |
JSONP | サーバーに対し、JSON ドキュメントを JavaScript 関数呼び出しで囲んで返すようにリクエストできます。 |
JWT (JSON Web Token) | 状態なしの Shop API は、認証メカニズムで JSON Web Token を使用します。 |
ローカライゼーション | API を異なる地域情報で使用できます。 |
メタデータ | 現在のバージョンなど、API 自体に関するメタデータをリクエストできます。 |
OAuth 2.0 | Data API のリクエストは、OAuth 2.0 プロトコルを使用して認証する必要があります。 |
OCAPI 設定 | OCAPI 設定は、Business Manager で JSON データ構造を変更して構成することができ、クライアントの許可、キャッシング、および、その他のリソースに特定の動作をコントロールできます。 |
楽観的ロック | OCAPI でサポートされている 2 つの楽観的ロックのメカニズムを記述します。 |
ページネーション | ページネーションを使用して、大規模なレスポンスを小さな部分に分割できます。 |
プロパティの選択 | プロパティセレクターを使用して、返されるリソースプロパティを制限できます。 |
リソースの状態 | リソースの状態は、同時実行されたリクエストの競合 (「失われた更新」の問題など) を防止する、楽観的ロックに使用できます。 |
セッションブリッジ | OCAPI とセッションベースのストアフロント間で、シームレスなインタラクションを可能にします。 |
システムジョブ | OCAPI リクエストで呼び出すことのできる、事前定義されたジョブ。 |
URL 構文 | リソースで操作を行うには、適切に構成された URL を作成する必要があります。 |
バージョン管理と廃止予定のポリシー | アプリケーションがバージョン管理と廃止予定のポリシーに準拠していることを必ず確認してください。 |