接続の確立

JDBC データソースの作成

Java アプリケーションから接続するJDBC データソースを CData JDBC Driver for Smaregi を使用して作成できます。

以下の手順に従います。

ドライバーのJAR ファイルをクラスパスに追加します。JAR ファイルはインストールディレクトリの lib サブフォルダ内にあります。.lic ファイルはJAR ファイルと同じフォルダ内に配置されていることを確認してください。
ドライバークラスを入力します。次に例を示します。
```
cdata.jdbc.smaregi.SmaregiDriver
```
JDBC URL を入力します。次に例を示します。
```
jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
```
アプリケーションで同じURL 形式を使用するドライバー間に競合がある場合は、CData ドライバーを使用していることを確認するために次の形式を使用します。
```
jdbc:cdata:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
```
URL は jdbc:smaregi: または jdbc:cdata:smaregi: のいずれかから始まります。 URL には、セミコロン区切りの名前と値のペアで任意の接続プロパティを含めることができます。

Smaregi への接続

Smaregi は、2種類の異なるAPI を通じてデータへのアクセスを提供しています。使用するAPI は、Schema 接続プロパティに以下のいずれかを設定することで指定します。

Smaregi：旧API です。
PlatformAPI：新しいAPI です。

Smaregi への認証

使用できる認証方式は、接続先のAPI によって異なります。

Access Token：Smaregi API でのみ利用可能です。
OAuth Client：Platform API でのみ利用可能です。
OAuth：Platform API でのみ利用可能です。

アクセストークン

この方法を使用して接続するには、AuthScheme をAccessToken に設定し、次のプロパティを設定します。

ContractId：Smaregi アカウントに関連付けられた契約ID。
AccessToken：Smaregi アカウントから生成されたアクセストークン。

これらの値を取得するには、Smaregi にログインし、 ［設定］＞［システム連携］＞［スマレジAPI 設定］に移動します。API 受信設定 セクションで、受信機能を利用するを利用するに設定し、アクセストークン発行をクリックしてアクセストークンを取得します。契約ID もこのセクションに表示されます。機能設定セクションで、必要なAPI 機能を有効にします。

OAuth Client

OAuth Client 認証は、OAuth クライアントクレデンシャルフローに従います。

この方法を使用して接続するには、カスタムOAuth アプリケーションの作成で説明されているようにカスタムアプリケーションを作成し、AuthScheme をOAuthClient に設定します。次に、以下のプロパティを指定します。

OAuthClientId：アプリケーションを登録した際に割り当てられたクライアントId。
OAuthClientSecret：アプリケーションを登録した際に割り当てられたクライアントシークレット。
ContractId：Smaregi アカウントに関連付けられた契約ID。

OAuth

認証するには、AuthScheme をOAuth に設定し、カスタムOAuth アプリケーションの作成で説明されているようにカスタムアプリケーションを作成します。

以下のセクションでは、異なる環境からOAuth を使用して認証する方法について説明します。

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

デスクトップアプリケーション経由で接続するには、OAuth アクセストークンを設定し、リフレッシュする必要があります。

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

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

InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
OAuthClientId：アプリケーションを登録した際に割り当てられたクライアントId。
OAuthClientSecret：アプリケーションを登録した際に割り当てられたクライアントシークレット。
CallbackURL：アプリケーションの登録時に定義されたCallback URL。デフォルトではhttp://localhost:33333 に設定されています。

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

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

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

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

Web アプリケーション

このセクションでは、OAuth アクセストークンの取得方法、本製品にOAuth アクセストークンを自動的に更新させる方法、および OAuth アクセストークンを手動で更新する方法について説明します。

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

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

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

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

本製品がOAuth アクセストークンを自動的にリフレッシュするようにするには：

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

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

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

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

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

ヘッドレスマシン

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

以下のいずれかの方法で行います。

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

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

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

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

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

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

このURL をコピーして、新しいブラウザのタブに貼り付けます。
ログインして、本製品にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

ヘッドレスマシンでは、OAuth 認証値を取得するには次のプロパティを設定します。
- InitiateOAuth：REFRESH。
- OAuthVerifier：verifier code（コールバックURL のcode パラメータの値）。
- OAuthClientId：アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションを登録した際に割り当てられたクライアントシークレット。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を指定された場所に永続化。
接続をテストしてOAuth 設定ファイルを生成します。
これらのプロパティを再設定すると、接続の準備が整います。
- InitiateOAuth：REFRESH。
- OAuthClientId：アプリケーションを登録した際に割り当てられたクライアントId。
- OAuthClientSecret：アプリケーションを登録した際に割り当てられたクライアントシークレット。
- OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。

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

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

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

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

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

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