Monaca アプリで使えるMicrosoft Dataverse のデータ連携用のバックエンドAPI をノーコードで開発

宮本航太
プロダクトスペシャリスト

ハイブリッドアプリ開発プラットフォームMonaca から Microsoft Dataverse のデータに接続するためのバックエンドAPI Server をCData API Server で構築

CData API Server を使って、Monaca ハイブリッドアプリ開発プラットフォーム(https://ja.monaca.io/) から Microsoft Dataverse に接続してデータを取得する方法を説明します。

Microsoft Dataverse データ連携について

CData は、Microsoft Dataverse（旧 Common Data Service）のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています：

Dataverse エンティティと Dataverse システムテーブルの両方にアクセスし、必要なデータを正確に扱うことができます。
Azure Active Directory、Azure マネージドサービス ID 認証情報、クライアントシークレットまたは証明書を使用した Azure サービスプリンシパルなど、さまざまな方法で Microsoft Dataverse に安全に認証できます。
SQL ストアドプロシージャを使用して、Microsoft Dataverse エンティティを管理できます。エンティティ間の関連付けの一覧表示、作成、削除などが可能です。

CData のお客様は、データをデータウェアハウスにレプリケートしたい場合（他のデータソースと併せて）や、Microsoft エコシステム内のお気に入りのデータツール（Power BI、Excel など）または外部ツール（Tableau、Looker など）からライブ Dataverse データを分析したい場合など、さまざまな理由で当社の Dataverse 接続ソリューションを使用しています。

はじめに

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなMicrosoft Dataverse OData サービスを作成していきましょう。

Microsoft Dataverse への接続

Monaca からMicrosoft Dataverse のデータを操作するには、まずMicrosoft Dataverse への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Microsoft Dataverse」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Microsoft Dataverse への接続設定を行っていきましょう！
ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、以下のとおりです。
- InitiateOAuth: GETANDREFRESH に設定します。
- OrganizationUrl: 接続先の組織のURL、例えばhttps://organization.crm.dynamics.com などに設定。
- Tenant (optional): デフォルトと異なるテナントに認証したい場合は、これを設定します。これは、デフォルトのテナントに所属していない組織と連携するために必要です。
接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、以下のとおりです。

InitiateOAuth: GETANDREFRESH に設定します。
OrganizationUrl: 接続先の組織のURL、例えばhttps://organization.crm.dynamics.com などに設定。
Tenant (optional): デフォルトと異なるテナントに認証したい場合は、これを設定します。これは、デフォルトのテナントに所属していない組織と連携するために必要です。

接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

API Server のユーザー設定

次に、API Server 経由でMicrosoft Dataverse にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Microsoft Dataverse 用のAPI エンドポイントの作成

ユーザーを作成したら、Microsoft Dataverse のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でMicrosoft Dataverse への接続を設定してユーザーを作成し、API Server でMicrosoft Dataverse データのAPI を追加しました。これで、OData 形式のMicrosoft Dataverse データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法記事を参考にしてください。

Monaca で作成したモバイルアプリでの Microsoft Dataverse のデータ取得

Monacaではクラウド上にあるIDEが用意されていますので、まずはアカウント作成します。そこからCData API Server のデータをMonaca アプリ使う設定を作成していきます。

ブラウザより Monaca のダッシュボードを開き、「新しいプロジェクトを作る」をクリックします。

まずはテンプレートの種類は、フレームワークテンプレートを選択します。

今回は JavaScript を選択します。

テンプレートは「Onsen UI V2 JS Navigation」を選択します。テンプレの画面構成は、「Push page」ボタンをクリックすると、画面遷移するものとなっています。

任意のプロジェクト名を設定し、「作成」ボタンをクリックします。

作成したプロジェクトを選択した状態で、「クラウドIDEで開く」をクリックします。

検索ボタンがクリックされたら、先ほど作成した API を Ajax で呼び出すようにしています。

API Server で作成したエンドポイントをURL に設定し、ヘッダーにAPI Server のアクセストークンを設定します。
レスポンスが返ってきた後、処理が成功していればリストにname だけを1データずつ加えています。