Monaca アプリで使えるWorkable のデータ連携用のバックエンドAPI をノーコードで開発
CData API Server を使って、Monaca ハイブリッドアプリ開発プラットフォーム(https://ja.monaca.io/) から Workable に接続してデータを取得する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなWorkable OData サービスを作成していきましょう。
Workable への接続
Monaca からWorkable のデータを操作するには、まずWorkable への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Workable」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Workable への接続設定を行っていきましょう！
-
API キー認証の設定
Workable は、API へのアクセスを制御するために API キー認証を使用します。API Key を取得するには、以下のステップで進めます：
- Workable アカウントにログインします。
- Settings > Integrations > API Access Tokens に移動します。
- 「Generate API Token」をクリックします。
- 生成されたトークンをコピーします。
API Key を取得したら、以下の接続プロパティを設定します：
- AuthScheme：APIKey に設定します。
- APIKey：Workable の API Key に設定します。
- Subdomain：Workable アカウントのサブドメインに設定します。たとえば、Workable の URL が acmeinc.workable.com の場合、Subdomain は 'acmeinc' になります。
接続文字列の例
Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Workable は、API へのアクセスを制御するために API キー認証を使用します。API Key を取得するには、以下のステップで進めます：
- Workable アカウントにログインします。
- Settings > Integrations > API Access Tokens に移動します。
- 「Generate API Token」をクリックします。
- 生成されたトークンをコピーします。
API Key を取得したら、以下の接続プロパティを設定します：
- AuthScheme：APIKey に設定します。
- APIKey：Workable の API Key に設定します。
- Subdomain：Workable アカウントのサブドメインに設定します。たとえば、Workable の URL が acmeinc.workable.com の場合、Subdomain は 'acmeinc' になります。
接続文字列の例
Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
API Server のユーザー設定
次に、API Server 経由でWorkable にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Workable 用のAPI エンドポイントの作成
ユーザーを作成したら、Workable のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でWorkable への接続を設定してユーザーを作成し、API Server でWorkable データのAPI を追加しました。これで、OData 形式のWorkable データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
オンプレミスDB やファイルからのAPI Server 使用（オプション）
オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。
Monaca で作成したモバイルアプリでの Workable のデータ取得
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データずつ加えています。
デバッグ実行してみる
Monaca でデバッグを行う際は、Monacaデバッガーアプリを実機にインストールすることで、MonacaのクラウドIDE と実機で動かしているMonacaデバッガーアプリが連動するようです。そのため、いちいちコードを修正してからのビルドが不要になるため、素早く検証を行うことができます。
また、Monaca Localkit を使うことで、ローカルの開発環境でも利用することができます。今回はこのLocalkit を使って vscode 上でコードを修正し、アプリ内容を確認していきました。
Monaca Localkit を起動し、プレビューを押すとすぐにアプリ画面が表示されます。
初期画面→検索→画面遷移まで確認することができました。
このように Workable 内のデータをMonaca アプリで利用することができるようになります。