OCAPI クライアントアプリケーションの識別 23.1

Open Commerce API では、すべてのクライアントアプリケーションがクライアント ID を使用して識別を行うことが必要です。

クライアント ID は、Open Commerce API のクライアント ID の追加の説明に従って Account Manager で取得できます。ID を取得後、有効になっていることを確認します。

組織内のすべてのクライアント ID のリストを表示するには、Account Manager の左側のナビゲーションメニューで API クライアントを選択します。

クライアント ID はすべての API リクエストに含めます。次のいくつかの方法で渡すことができます。

1. Authorization token を必要とするリクエストの場合、クライアント ID は提供されたトークンから決定されます:

   1. JWT: クライアント ID は、トークンの payload 内で 'issuer' の要求として埋め込まれます。
   2. OAuth: クライアント ID は、トークンを使用して Account Manager から解決されます。

2. client_id リクエストパラメーターでクライアント ID を渡す方法:

3. x-dw-client-id HTTP ヘッダーでクライアント ID を渡す方法:

クライアント ID を指定するメカニズムが複数使用されている場合は、次の優先順位を使用して解決が行われます。

1. Bearer token
2. リクエストパラメーター
3. HTTP ヘッダー

クライアント ID を指定しないと、HTTP ステータス 400 (Bad Request (無効なリクエスト)) がサーバーから返されます。

クライアント ID は Account Manager で有効になっていることが必要です。クライアント ID は、再検証が行われるまで一定期間キャッシュされるため、クライアント ID を有効または無効にしても、ステータスはすぐには変更されません。