JDBC Driver for Shopify

Build 22.0.8479

接続の確立

JDBC データソースの作成

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

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

or

jdbc:cdata:shopify:InitiateOAuth=GETANDREFRESH;ShopUrl=https://yourshopname.myshopify.com;OAuthClientId=myoauthclientid;OAuthClientSecret=myoauthclientsecret;

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

Shopify への接続

すべてのケースで、Shopify ショップの完全URL に設定する必要があります（https://yourshopname.myshopify.com）。以下のドキュメントは、すでに設定済みであることを前提として書かれています。

アクセストークン

カスタムアプリの作成

認証の前に、Shopify の管理画面からカスタムアプリを作成する必要があります。アプリを登録してアクセストークンを取得する方法は、次のとおりです。

  1. 管理画面からShopify にログインしApps -> Apps and sales channels に進みます。
  2. Develop apps をクリックしてCreate an app を選択します。
  3. Overview タブで、Configure Admin API scopes をクリックし、アプリに許可するストアのアクセス権を選択します。プロバイダーがすべてのテーブルとビューを使用するために必要な権限は次のとおりです。
    • read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
    • read_content, write_content
    • read_customers, write_customers
    • read_draft_orders, write_draft_orders
    • read_fulfillments, write_fulfillments
    • read_gift_cards, write_gift_cards
    • read_inventory, write_inventory
    • read_marketing_events, write_marketing_events
    • read_orders, write_orders
    • read_price_rules, write_price_rules
    • read_product_listings, write_product_listings
    • read_products, write_products
    • read_reports, write_reports
    • read_script_tags, write_script_tags
    • read_shopify_payments_payouts
    • read_themes, write_themes
  4. Save をクリックします。
  5. API Credentials を選択します。
  6. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます。
  7. Admin API Access token のアクセストークンをコピーします。NOTE：トークンの公開およびコピーは1回のみ可能です。

アクセストークン

アクセストークンで認証するには、次を設定します。

  • AuthScheme：AccessToken に設定。
  • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定。

OAuth

OAuth を使って接続するには、Shopify パートナーダッシュボードでパブリックアプリまたはカスタムアプリの作成が必要です。この処理中に、API key とAPI secret key の値が生成されます。これらのキーは、カスタムアプリケーションを使用して接続するときに必要です。手順については、カスタムOAuth アプリの作成 を参照してください。

Note： AuthScheme をOAuth に設定する必要があります。以下のセクションは、すでに設定済みであることを前提として書かれています。設定されていない場合、接続できません。

デスクトップ認証

カスタムアプリケーションを作成し、クライアントId およびクライアントシークレットプロパティを指定する必要があります。

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

  • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。
  • OAuthClientId：アプリのAPI キーの値に設定。
  • OAuthClientSecret：アプリのAPI シークレットキーの値に設定。
  • CallbackURL：アプリの登録時に定義されたリダイレクトURI に設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 は接続間で持続するOAuthSettingsLocation にOAuth 値を保存し、古いトークンの期限が切れたときは新しいアクセストークンを取得することで、OAuth プロセスを完了します。

カスタムOAuth アプリでのWeb 認証

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

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

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

  • OAuthClientId：アプリのAPI キーの値に設定。
  • OAuthClientSecret：アプリのAPI シークレットキーの値に設定。

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

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

ヘッドレスマシン

ヘッドレスサーバーや、本製品 がブラウザを開くことができないその他のマシンにShopify データソースを作成するには、別のマシンから認証を行う必要があります。認証は、2段階認証プロセスになります。

  1. 本製品 を別のマシンにインストールする代わりに、次の手順に従ってOAuthVerifier 値を取得できます。または、別のマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送することもできます。
  2. その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。
カスタムOAuth アプリのOAuth クレデンシャルを使用して、ヘッドレスOAuth 認証フローに従うことができます。

カスタムOAuth アプリの作成

手順については、カスタムOAuth アプリの作成 を参照してください。下記の手順に従って、データの認証および接続を行うことができます。

Verifier code を取得

ヘッドレスマシンで次のプロパティを設定します。

  • InitiateOAuth：OFF に設定。
  • OAuthClientId：API キーに設定。
  • OAuthClientSecret：API シークレットキーに設定。

別のマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. CallbackURL 入力パラメータを、アプリ設定で指定した正確なリダイレクトURI に設定して、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。
  2. 返されたURL をブラウザで開きます。ログインして、本製品 にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. verifier code の値を保存します。これをOAuthVerifier 接続プロパティに設定します。

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

  • OAuthClientId：API キーに設定。
  • OAuthClientSecret：API シークレットキーに設定。
  • OAuthVerifier：verifier code に設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定されたファイルに永続化されます。
  • InitiateOAuth：REFRESH に設定。

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

  • OAuthClientId：API キーに設定。
  • OAuthClientSecret：API シークレットキーに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を含むファイルに設定。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。
  • InitiateOAuth：REFRESH に設定。

OAuth 設定を転送

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

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

  • OAuthSettingsLocation：書き込み可能なテキストファイルのパスに設定。
  • InitiateOAuth：GETANDREFRESH に設定。
  • OAuthClientId：アプリのAPI キーの値に設定。
  • OAuthClientSecret：アプリのAPI シークレットキーの値に設定。
  • CallbackURL：アプリケーション設定で指定したリダイレクトURI に設定。

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

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリのAPI キーの値に設定。
  • OAuthClientSecret：アプリのAPI シークレットキーの値に設定。
  • OAuthSettingsLocation：OAuth 設定ファイルのパスに設定。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479