Aqua Data Studio で ApprovalMax のデータ に接続

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Visual Query Builder やテーブルデータエディターなど、Aqua Data Studio のツールから ApprovalMax のデータ にアクセスできます。



CData JDBC Driver for ApprovalMax は、Aqua Data Studio などの IDE のウィザードや分析機能と ApprovalMax のデータ を連携できます。本記事では、接続マネージャーを使って ApprovalMax のデータ に接続し、クエリを実行する方法を説明します。

JDBC データソースの作成

接続マネージャーを使用して接続プロパティを定義し、新しい JDBC データソースとして保存できます。作成した ApprovalMax データソースは、Aqua Data Studio の各ツールからアクセスできるようになります。

  1. Aqua Data Studio で、Servers メニューから Register Server を選択します。
  2. Register Server フォームで、「Generic - JDBC」接続を選択します。
  3. 以下の JDBC 接続プロパティを入力します:
    • Name: データソースの名前を入力します(例:ApprovalMax)。
    • Driver Location: Browse ボタンをクリックし、インストールディレクトリの lib サブフォルダにある cdata.jdbc.api.jar ファイルを選択します。
    • Driver: ドライバーのクラス名 cdata.jdbc.api.APIDriver を入力します。
    • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後にセミコロン区切りで接続プロパティを指定します。

      まず、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 URL を生成(画面は Salesforce) 一般的な JDBC URL は以下のとおりです:
      jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;
    JAR ファイルパス、ドライバークラス、JDBC URL で定義された JDBC データソース(画面は QuickBooks)

ApprovalMax のデータ へのクエリ

これで、公開されているテーブルにクエリを実行できます。

テーブルデータエディターで実行されたクエリ(画面は QuickBooks)

はじめる準備はできましたか?

API Driver で ApprovalMax のライブデータに接続

ApprovalMax に接続