JDBC Driver for Shopify

Build 23.0.8839

接続の確立

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 への接続

このセクションでは、Web、デスクトップアプリケーション、ヘッドレスアプリケーションからShopify に接続する方法について説明します。

アクセストークンによる接続

アクセストークン経由の接続には、2つのステップが必要です。

  1. Shopify の管理画面でアクセストークンを作成
  2. アクセストークンを使用して認証

アクセストークンの作成

アプリを登録してアクセストークンを取得する方法は、次のとおりです。

  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
    • read_markets
    • read_shopify_payments_accounts
    • read_publications
    • unauthenticated_read_content (Storefront API)
  4. Save をクリックします。
  5. API Credentials を選択します。
  6. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます。
  7. Admin API Access token のアクセストークンをコピーします。NOTE：トークンの公開およびコピーは1回のみ可能です。

アクセストークンによる認証

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

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

OAuth での接続

Shopify はOAuth 認証をサポートします。いかなる場合も、AuthScheme をOAuth に設定してカスタムOAuth アプリケーションを作成する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。

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

下記の手順に従って、カスタムOAuth アプリケーションの資格情報を使用して認証します。

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

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

  • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • CallbackURL：アプリケーションの登録時に定義されたリダイレクトURI に設定。
接続すると、本製品 はデフォルトブラウザでShopify のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 はこれでOAuth プロセスを完了します。
  1. 本製品 はShopify からアクセストークンを取得し、それを使ってデータをリクエストします。
  2. OAuth 値はOAuthSettingsLocation で指定された場所に保存されます。これらの値は接続間で永続化されます。
本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。

Web アプリケーション

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

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

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

  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

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

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

アクセストークンとリフレッシュトークンを取得したのち、データに接続してOAuth アクセストークンを自動的にリフレッシュできます。

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

本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
  • OAuthSettingsLocation：本製品 がOAuth 値を保存する場所に設定。これは接続間で維持されます。

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

  • InitiateOAuth
  • OAuthSettingsLocation

ヘッドレスマシン

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

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

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

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

次の手順に従います。

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

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

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
  • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

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

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

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

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名は"OAuthSettings.txt" です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

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

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