JDBC Driver for Amazon Marketplace

Build 24.0.9062

接続の確立

JDBC データソースの作成

Java アプリケーションから接続するJDBC データソースを作成できます。CData JDBC Driver for Amazon Marketplace に基づくJDBC データソースの作成は、3つの基本ステップで構成されます。

  • ドライバーのJAR ファイルをクラスパスに追加します。JAR ファイルはインストールディレクトリの［lib］サブフォルダ内にあります。.lic ファイルはJAR ファイルと同じフォルダ内に配置される必要があることに注意してください。
  • ドライバークラスを入力します。次に例を示します。 
    cdata.jdbc.amazonmarketplace.AmazonMarketplaceDriver
  • JDBC URL を入力します。次に例を示します。 
    jdbc:amazonmarketplace:InitiateOAuth=GETANDREFRESH;Marketplace=United States;

or

jdbc:cdata:amazonmarketplace:InitiateOAuth=GETANDREFRESH;Marketplace=United States;

    上記の2つ目の形式は、同じURL 形式を使用しているドライバー間でアプリケーションに競合がある場合は、CData ドライバーを使用していることを確認するために常に使用できます。URL は "jdbc:amazonmarketplace:" または"jdbc:cdata:amazonmarketplace:" のいずれかから始まり、任意の接続プロパティの名前と値のペアをセミコロン区切りで入力します。

Amazon Marketplace への接続

以下のプロパティが必須です。

  • Schema：SellerCentral に設定。
  • InitiateOAuth：GETANDREFRESH に設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。

Amazon Marketplace への認証

OAuth

Amazon Marketplace はOAuth 認証標準を利用しています。

OAuth で認証するには、組み込みアプリケーションを使用するか、新しいカスタムOAuth アプリを作成する必要があります。組み込みアプリケーションは、デスクトップアプリケーションおよびヘッドレスマシンをサポートします。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。

カスタムOAuth アプリケーションを使用して、サービスアカウントまたはユーザーアカウントで認証できます。詳しくは、カスタムOAuth アプリの作成 を参照してください。

埋め込みクレデンシャルのダウンロード

Amazon Marketplace は埋め込みクレデンシャルを6ヶ月ごとに入れ替える必要があるため、CData のクレデンシャルはoa.cdata.com でホストされます。カスタムクレデンシャルを指定しない場合、CData のWeb サービスから埋め込みクレデンシャルがダウンロードされ、デフォルトでOAuthClientLocation で指定した場所に保存されます。 NOTE：ファイアウォールがoa.cdata.com をブロックしないことを確認してください。

デスクトップアプリ

組み込みアプリケーションを使用するか、カスタムOAuth アプリケーションを作成することが可能です。主要な違いは、カスタムアプリケーションを使用する場合は追加の接続プロパティを設定する必要があることです。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId に設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。
  • OAuthClientId（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 はこれでOAuth プロセスを完了します。

  1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
  2. アクセストークンの期限が切れたときにはリフレッシュしてください。
  3. OAuth 値をOAuthSettingsLocation に保存します。これらの値は接続間で永続化されます。

Web アプリ

Web アプリケーション経由で接続する場合は、Amazon Marketplace にカスタムOAuth アプリケーションを登録する必要があります。それから本製品 を使用してOAuth トークンの値を取得および管理します。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

  1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"spapi_oauth_code" パラメータに設定します。

OAuth アクセストークンのリフレッシュ

InitiateOAuth をREFRESH に設定してOAuth アクセストークンの期限が切れたときに自動的にリフレッシュするか、RefreshOAuthAccessToken ストアドプロシージャを呼び出してトークンを手動でリフレッシュできます。

自動リフレッシュ

InitiateOAuth でトークンをリフレッシュするには、最初のデータ接続で次のように設定します。

  • OAuthAccessToken：これをGetOAuthAccessToken によって返されたアクセストークンに設定します。
  • InitiateOAuth：REFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
  • OAuthSettingsLocation：本製品 がOAuth 値を保存する場所に設定。これらの値は接続間で永続化されます。
  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • OAuthRefreshToken：これをGetOAuthAccessToken によって返されたリフレッシュトークンに設定します。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

その後のデータ接続では、以下を設定します。

  • InitiateOAuth
  • OAuthSettingsLocation
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

手動でリフレッシュ

GetOAuthAccessToken ストアドプロシージャを使用してOAuthAccessToken を手動でリフレッシュできます。GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後にストアドプロシージャを呼び出します。以下の接続プロパティが設定されている必要があります。

  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。

次のパラメータセットを使用してRefreshOAuthAccessToken を呼び出すことができます。

  • OAuthRefreshToken：これをGetOAuthAccessToken によって返されたOAuthRefreshToken に設定します。

ヘッドレスマシン

ドライバーを設定するため、ヘッドレスマシンでユーザーアカウントにOAuth を使用します。ユーザーアカウントまたはサービスアカウントを使って、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下の2つのオプションから選択します。

    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：別のマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

  2. その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

別のマシンから認証してOAuthVerifier 接続プロパティを取得するには、次の手順を実行してください。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId（カスタムアプリのみ）：アプリケーション設定のクライアントId に設定。
      • OAuthClientSecret（カスタムアプリのみ）：アプリケーション設定のクライアントシークレットに設定。

        次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

  2. ログインして、本製品 にアクセス許可を与えます。'spapi_oauth_code' の値としてverifier code を含むコールバックURL にリダイレクトされます。verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定する必要があります。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthVerifier：verifier code に設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
  • InitiateOAuth：REFRESH に設定。

OAuth 設定ファイルが生成されたら、次のプロパティを設定してデータに接続します。

  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がプロバイダーに読み書きのアクセス許可を与えることを確認してください。
  • InitiateOAuth：REFRESH に設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

オプション2：OAuth 設定を転送

別のマシンに本製品 をインストールして認証し、結果のOAuth 値を転送する方法は次のとおりです。

セカンドマシンに、本製品 をインストールして、次の接続プロパティセットで接続します。

  • OAuthSettingsLocation：書き込み可能な場所に設定。
  • InitiateOAuth：GETANDREFRESH に設定。
  • OAuthClientId（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。

認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定されたパスにあるファイルに暗号化されて書き込まれます。接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062