DBArtisan で ApprovalMax のデータ を JDBC データソースとして管理
CData JDBC Driver for ApprovalMax を使えば、ApprovalMax のデータ をデータベースとしてアクセスできるようになり、DBArtisan などのデータベース管理ツールとシームレスに連携できます。この記事では、DBArtisan で ApprovalMax の JDBC データソースを作成する方法を説明します。一度接続すれば、データを視覚的に編集したり、標準 SQL を実行したりすることができます。
ApprovalMax のデータ を DBArtisan プロジェクトに統合
以下のステップに従って、プロジェクトに ApprovalMax のデータ をデータベースインスタンスとして登録します。
- DBArtisan で、Data Source -> Register Datasource をクリックします。
- Generic JDBC を選択します。
- Manage をクリックします。
- 表示されたダイアログで、New をクリックします。ドライバーの名前を入力し、Add をクリックします。次に表示されるダイアログで、ドライバー JAR ファイルを指定します。ドライバー JAR はインストールディレクトリの lib サブフォルダ内にあります。
-
Connection URL ボックスに、資格情報やその他の必要な接続プロパティを JDBC URL 形式で入力します。
まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します(例:C:\profiles\ApprovalMax.apip)。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します(以下を参照)。
ApprovalMax API プロファイル設定
ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。
まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal(https://developer.approvalmax.com/applications)にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI(Callback URL)を少なくとも1つ登録しておく必要があります。
Public API を利用するには、ApprovalMax の Premium サブスクリプション(または有効なトライアル)が必要です。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
- OAuthClientSecret:ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
- CallbackURL:アプリケーション設定で登録した Redirect URI に設定します。
- Scope:(オプション)デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。
OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。
組み込みの接続文字列デザイナー
JDBC URL の構成には、ApprovalMax JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
java -jar cdata.jdbc.api.jar接続プロパティを入力し、接続文字列をクリップボードにコピーします。
一般的な接続文字列は以下のとおりです。
jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url; - ウィザードを完了して、ApprovalMax のデータ に接続します。ApprovalMax エンティティが Datasource Explorer に表示されます。
これで、他のデータベースと同じように ApprovalMax のデータ を操作できます。 ApprovalMax API でサポートされるクエリの詳細については、ドライバーのヘルプドキュメントを参照してください。