JDBC Driver for eBay Analytics

Build 23.0.8839

接続の確立

JDBC データソースの作成

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

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

or

jdbc:cdata:ebayanalytics:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;

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

eBay Analytics への接続

eBay Analytics への接続を確立し、OAuth 2.0認証方法でのみ認証することができます。eBay Analytics API では、リクエストの認可に、認証コード付与フローで作成されたアクセストークンが必要です。

eBay Analytics への認証

eBay Analytics はOAuth 認証のみをサポートします。AuthScheme は、すべてのOAuth フローでOAuth に設定する必要があります。

デスクトップアプリケーション

デスクトップアプリケーション経由で認証するには、カスタムOAuth アプリケーションの作成が必要です。詳しくは、カスタムOAuth アプリの作成 を参照してください。

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

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

  • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
  • OAuthClientId：アプリケーションの登録時に割り当てられたApp Id（クライアントId）に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたCert Id（クライアントシークレット）に設定。
  • RuName：'Application access' セクションのOAuth アプリケーションのリダイレクトURL名に設定。
  • CallbackURL（オプション）：OAuth アプリケーションの認証済みURL がhttps://oauth.cdata.com/oauth/ に設定されている場合はローカルのリダイレクトURL（例：http://localhost:33333）に設定し、他のリダイレクトURL を使用している場合は実際のURL に設定。
  • （オプション）UseSandbox：Sandbox 環境に接続している場合は、これをTrue に設定。
接続すると、本製品 はデフォルトブラウザでeBay Analytics のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 はこれでOAuth プロセスを完了します。

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

Web アプリケーション

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

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

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

  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • RuName：Application access セクションのOAuth アプリケーションのリダイレクトURL 名に設定。
  • UseSandbox（オプション）：Sandbox 環境に接続している場合は、これをTrue に設定。

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

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

    NameValue
    AuthModeWEB
    Verifierverifier code に設定。

eBay Analytics にリクエストを投げるには、OAuthAccessToken をステップ3 で返された値に設定します。

トークンの期限が切れたときに自動でリフレッシュするには、InitiateOAuth をREFRESH に設定します。

ヘッドレスマシン

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

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

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

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 次のプロパティを設定します。
    • InitiateOAuth：OFF に設定。
    • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
    • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
    • RuName：'Application access' セクションのOAuth アプリケーションのリダイレクトURL 名に設定。
    次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

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

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：キーセットのApp ID (Client ID) に設定します。
  • OAuthClientSecret：キーセットのCert ID (Client Secret) に設定します。
  • RuName：'Application access' セクションのOAuth アプリケーションのリダイレクトURL 名に設定。
  • OAuthVerifier：verifier code に設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を指定された場所に永続化。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

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

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。

  1. インターネットブラウザのあるマシンに本製品 をインストールし、次の接続プロパティを設定した後に接続します。
    • OAuthSettingsLocation：書き込み可能な場所に設定。
    • InitiateOAuth：GETANDREFRESH に設定。
    • OAuthClientId：キーセットのApp ID (Client ID) に設定します。
    • OAuthClientSecret：キーセットのCert ID (Client Secret) に設定します。
    • RuName：'Application access' セクションのOAuth アプリケーションのリダイレクトURL 名に設定。
    • （オプション）CallbackURL：OAuth アプリケーションの認証済みURL がhttps://oauth.cdata.com/oauth/ に設定されている場合はローカルのリダイレクトURL（例：http://localhost:33333）に設定し、他のリダイレクトURL を使用している場合は実際のURL に設定。
  2. 認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
    • InitiateOAuth：REFRESH に設定。
    • OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

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