ApprovalMax のデータ 用のシンプルな VCL アプリケーションを構築
Embarcadero RAD Studio は、Delphi および C++Builder アプリケーション用の開発環境を提供します。CData ODBC Driver for ApprovalMax を使用すると、RAD Studio 内からリアルタイムApprovalMax のデータにアクセスでき、データをテーブル、ビュー、ストアドプロシージャとして抽象化してApprovalMax のデータの取得が可能です。この記事では、ApprovalMax に接続し、フォームデザイナを使用してシンプルな VCL アプリケーションを作成する方法を説明します。
ApprovalMax のデータ への接続を作成
まだ設定していない場合は、ODBC DSN(データソース名)で接続プロパティを指定します。これはドライバーインストールの最後のステップです。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成・設定できます。
まず、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 の両方に対応しています。
次に、以下の手順で Data Explorer を使用してApprovalMax のデータへの FireDAC 接続を作成します。
- 新しい VCL フォームアプリケーションで、Data Explorer の FireDAC ノードを展開します。
- Data Explorer で ODBC Data Source ノードを右クリックします。
- [新しい接続の追加] をクリックします。
- 接続の名前を入力します。
- 表示される FireDAC Connection Editor で、DataSource プロパティに ApprovalMax 用 ODBC DSN の名前を設定します。
ApprovalMax のデータ に接続する VCL アプリケーションを作成
以下の手順に従って、クエリ結果をグリッドに表示するシンプルな VCL アプリケーションからApprovalMax のデータへのクエリ実行を開始します。
-
TFDConnection コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- ConnectionDefName:ApprovalMax のデータへの FireDAC 接続を選択します。
- Connected: メニューから True を選択し、表示されるダイアログで資格情報を入力します。
-
TFDQuery コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- Connection: まだ指定されていない場合は、このプロパティを TFDConnection コンポーネントに設定します。
SQL: SQL プロパティのボタンをクリックしてクエリを入力します。例:
SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'- Active: このプロパティを true に設定します。
TDataSource コンポーネントをフォームにドロップし、以下のプロパティを設定します。
- DataSet: このプロパティのメニューで、TFDQuery コンポーネントの名前を選択します。
-
TDBGrid コントロールをフォームにドロップし、以下のプロパティを設定します。
- DataSource: TDataSource の名前を選択します。
- TFDGUIxWaitCursor をフォームにドロップします。これはランタイムエラーを回避するために必要です。
これで、TFDQuery オブジェクトに設定された SQL クエリの結果を表示する実行可能なアプリケーションが完成しました。
関連記事
RAD Studio、Delphi、C++ Builder で CData ODBC ドライバを使用するその他の記事は以下をご覧ください。