接続の確立

コネクタ内で利用可能なオブジェクトは、"cdata.quickbooksonline" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには：

モジュールを以下のようにインポートします。
```
import cdata.quickbooksonline as mod
```
接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
```
mod.connect("InitiateOAuth=GETANDREFRESH;")
```

QuickBooks Online への認証

QuickBooks Online は、デスクトップアプリケーション、Web ブラウザ、またはヘッドレスマシン経由での接続と認証をサポートしています。 CData Python Connector for QuickBooks Online には、デスクトップまたはヘッドレスマシンからの接続を簡素化し、限定的な機能を提供する埋め込みOAuth 認証情報が含まれています。ただし、デスクトップまたはヘッドレスマシン接続経由でより完全な機能を利用する場合、またはWeb 経由で接続する場合は、カスタムOAuth アプリケーションの作成で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、すべてのOAuth ワークフローからQuickBooks Online に認証する方法を説明します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。 QuickBooks Online で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

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

接続に必要なプロパティは、埋め込みOAuth 認証情報（限定的な使用）経由で接続するか、カスタムOAuth アプリケーション（完全な機能）経由で接続するかによって異なります。

接続する前に、必要なプロパティを設定してください。

InitiateOAuth（全ユーザー）：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
OAuthClientId （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
OAuthClientSecret （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
CallbackURL （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI（カスタムOAuth アプリケーションの作成参照）。

接続すると、本製品はデフォルトブラウザでQuickBooks Online のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

アプリケーションにアクセス許可を与えると、本製品はOAuth プロセスを完了します。

本製品はQuickBooks Online からアクセストークンを取得し、それを使ってデータをリクエストします。
OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます。

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

Web アプリケーション

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

このセクションでは、OAuth アクセストークンの取得方法、ドライバーにOAuth アクセストークンを自動的に更新させる方法、OAuth アクセストークンを手動で更新する方法について説明します。

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

OAuthAccessToken を取得するには、次の接続プロパティを設定します。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
ストアドプロシージャを呼び出し、OAuth 交換を完了します。
- GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL をカスタムOAuth アプリケーション設定で指定したリダイレクトURI に設定します。ストアドプロシージャは、OAuth エンドポイントへのURL を返します。
- ステップ1でストアドプロシージャが返したURL に移動します。ログインしてWeb アプリケーションを認可します。コールバックURL にリダイレクトされます。
- GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURI のクエリ文字列のcode パラメータに設定します。

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

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

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

はじめてデータに接続する際、次の接続プロパティを設定します。
- InitiateOAuth：REFRESH。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation：本製品がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

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

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。以下のいずれかの方法で行います。

オプション1：OAuthVerifier 値を取得します。
オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

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

Verifier コードを取得するには、次のようにOAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
- InitiateOAuth：OFF。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します（カスタムOAuth アプリケーションの作成参照）。

このURL をコピーして、新しいブラウザのタブに貼り付けます。
ログインして、本製品にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。ヘッドレスマシンでは、OAuthAccessToken を取得するには次の接続プロパティを設定します。
- InitiateOAuth（全ユーザー）：REFRESH。
- OAuthVerifier（全ユーザー）：控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
- OAuthSettingsLocation（全ユーザー）：暗号化されたOAuth 認証値を指定されたファイルに永続化。
- OAuthClientId （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
- OAuthClientSecret （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。
- 接続をテストしてOAuth 設定ファイルを生成します。
- これらのプロパティを再設定すると、接続の準備が整います。
  - InitiateOAuth（全ユーザー）：REFRESH。
  - OAuthSettingsLocation（全ユーザー）：暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
  - OAuthClientId （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID（カスタムOAuth アプリケーションの作成参照）。
  - OAuthClientSecret （カスタムOAuth のみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット（カスタムOAuth アプリケーションの作成参照）。

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

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

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

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

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

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