ローコードアプリ開発プラットフォームRetool でAcumatica 連携アプリを作成

Retool はローコードでWebベースの業務アプリケーションを構築できるクラウドサービスです。この記事では、CData API Server を経由して Retool からAcumatica に連携するアプリを作成する方法を説明します。

CData API Server は、Acumatica のデータのクラウド to クラウドの仮想OData インターフェースを提供し、Retool からリアルタイムにAcumatica のデータへ連携することができます。

API Server の設定

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

Acumatica への接続

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

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Acumatica」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Acumatica への接続設定を行っていきましょう！

5. Acumatica 接続プロパティの取得・設定方法

   Acumatica への接続

   Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。

   • URL：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
   • Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
   • Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
   • EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：24.200.001。これはREST スキーマにのみ適用されます。
   • EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。
   詳細はヘルプドキュメントの「接続の確立」セクションを参照してください。

   Acumatica への認証

   Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Acumatica 接続プロパティの取得・設定方法

Acumatica への接続

Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。

• URL：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
• Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
• Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
• EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：24.200.001。これはREST スキーマにのみ適用されます。
• EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。

Acumatica への認証

Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。

API Server のユーザー設定

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

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

Acumatica 用のAPI エンドポイントの作成

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

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

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

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

リソースの登録

続いてRetool 側の手順を進めていきます。Retool ではまず、構成したAPI にアクセスするためのリソース情報を登録します。

1. Retool にログインし、「Resouces」から「Create new」をクリックします。

2. 接続できるサービスの一覧が表示されるので「REST API」を選択します。

3. REST APIの設定画面では以下の通り必要な情報を入力します。Base URLには事前に作成したAPI のリソースエンドポイントを指定します。Headers には生成したユーザーの認証トークンを「x-cdata-authtoken」ヘッダーとして指定します。

4. リソースを作成後、アプリの作成確認ダイアログが出てくるので、今回はこれで作成してしまいます。（もちろんテンプレートなどを使っても構いません。）

5. 任意の名称を指定してください。

一覧画面の作成

リソースの登録が完了したら一覧画面を作成しましょう。

1. まず、先程登録したAPIのコネクションを使って、データを取得するための「Query」を定義します。すでに登録されているQueryの名前を変更し内部のAPIを定義を調整します。

2. デフォルトで Action Type、つまりAPIリクエストのメソッドが「GET」なので、このままでもデータは取得できます。ただ、初期状態ではすべての項目を取得してしまうので、API Serverがサポートするクエリパラメータを使って、取得項目やフィルター条件等を指定します。

3. URL parmeters を記述したら、設定を保存して実行してみましょう。以下のようにデータが取得できればOKです。

4. あとはこのデータを画面に表示するための「Table」UIコンポーネントを画面に配置します。

5. デフォルトえはJSON形式のサンプルデータが表示されているので、これを変更します。

6. 先程のクエリ名と対象のオブジェクト名を「{{QueryName.data.value}}」といった形で指定するだけでOKです。これだけで簡単に一覧画面が構成できました。

7. 作成した画面はプレビューモードで動作確認できます。

このように、CData API Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをRetool で開発できます。他にも多くのデータソースに対応するCData API Server の詳細をこちらからご覧ください。