接続の確立

JDBC データソースの作成

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

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

or

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

Airtable への接続

本製品は、Airtable にテーブルとビューを要求します。以下を設定して接続します。

BaseId（オプション）：オプションで、このプロパティまたはBaseName のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これをベースID に設定します。
- この値を見つけるにはthe Airtable API Reference に移動してベースを選択します。選択したベースについてのAirtable ドキュメントのIntroduction セクションで、The ID of this base is <Id> で指定された値を控えておきます。
BaseName（オプション）：オプションで、このプロパティまたはBaseId のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これを、Airtable のBase の名前に対応する、使用するスキーマの名前に設定します。

Airtable への認証

個人用アクセストークンまたはOAuth PKCE のいずれかを使用して、Airtable に認証できます。

個人用アクセストークン

まだ個人用アクセストークンを生成していない場合は、はじめに生成します。

ユーザーアカウントにログインします。
token creation page に移動します。
Create new token をクリックします。
Scopes で、Add a scope をクリックして以下の各スコープを追加します。
- data.records:read
- data.records:write
- schema.bases:read
Access で、トークンにアクセス権を付与するすべてのワークスペースとベースを追加します。
Create token をクリックしてトークンを生成します。生成されたトークンは一度しか表示されないので、コピーして保存します。

次に、以下を設定します。

AuthScheme：PersonalAccessToken に設定。
OAuthAccessToken：先ほど生成した個人用アクセストークンの値に設定。

OAuth PKCE

AuthScheme をOAuthPKCE に設定します。

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

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成を参照してください。

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

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

InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
OAuthClientId（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
CallbackURL（カスタムアプリのみ）：アプリの登録時に定義されたリダイレクトURI に設定。例： http://localhost:3333

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

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

本製品はアクセストークンの期限が切れると自動的にリフレッシュします。

Web アプリケーション

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

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

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

OAuthClientId：アプリ設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。

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

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier 値をを返します。あとで使用するためにPKCEVerifier の値を控えておきます。
ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。このプロシージャのPKCEVerifier インプットを、ステップ1で実行されたGetOAuthAuthorizationURL プロシージャからのPKCEVerifier アウトプットに設定します。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

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

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

InitiateOAuth：REFRESH に設定。
OAuthClientId：アプリ設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
OAuthSettingsLocation：本製品がOAuth 値を保存する場所に設定。これは接続間で維持されます。

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

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 RefreshOAuthAccessToken ストアドプロシージャを使用して、GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に手動でOAuthAccessToken をリフレッシュし、次の接続プロパティを設定します。

OAuthClientId：アプリ設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

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

ヘッドレスマシン

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

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

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

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

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

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier 値をを返します。あとで使用するためにPKCEVerifier の値を控えておきます。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。

リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。

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

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

InitiateOAuth：REFRESH に設定。
OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
PKCEVerifier：ステップ1で説明したPKCEVerifier の値に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

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

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。OAuth カスタムアプリケーションの作成プロセスで値が生成されなかった場合、この値の指定は任意です。
OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

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

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

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

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

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

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