Bubble で使えるServiceDesk Plus のデータ連携用のバックエンドAPI をノーコードで開発
CData API Server を使って、Bubble から ServiceDesk Plus に接続してデータを取得する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなServiceDesk Plus OData サービスを作成していきましょう。
ServiceDesk Plus への接続
Bubble からServiceDesk Plus のデータを操作するには、まずServiceDesk Plus への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「ServiceDesk Plus」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、ServiceDesk Plus への接続設定を行っていきましょう!
-
OAuth 認証の設定
ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます:
- https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
- アプリケーション構成に合わせてリダイレクト URI を設定します
- アプリケーション設定から Client ID と Client Secret を控えておきます
以下の接続プロパティを設定して接続を確立してください:
- AuthScheme:OAuth に設定します。
- OAuthClientId:Zoho アプリケーションの Client ID に設定します。
- OAuthClientSecret:Zoho アプリケーションの Client Secret に設定します。
- Scope:必要な ServiceDeskPlus の権限に設定します(デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます)。
- Domain:ServiceDeskPlus のドメインに設定します。
- Portal:ServiceDeskPlus のポータルに設定します。
接続文字列の例
Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
OAuth 認証の設定
ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます:
- https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
- アプリケーション構成に合わせてリダイレクト URI を設定します
- アプリケーション設定から Client ID と Client Secret を控えておきます
以下の接続プロパティを設定して接続を確立してください:
- AuthScheme:OAuth に設定します。
- OAuthClientId:Zoho アプリケーションの Client ID に設定します。
- OAuthClientSecret:Zoho アプリケーションの Client Secret に設定します。
- Scope:必要な ServiceDeskPlus の権限に設定します(デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます)。
- Domain:ServiceDeskPlus のドメインに設定します。
- Portal:ServiceDeskPlus のポータルに設定します。
接続文字列の例
Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
API Server のユーザー設定
次に、API Server 経由でServiceDesk Plus にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
ServiceDesk Plus 用のAPI エンドポイントの作成
ユーザーを作成したら、ServiceDesk Plus のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でServiceDesk Plus への接続を設定してユーザーを作成し、API Server でServiceDesk Plus データのAPI を追加しました。これで、OData 形式のServiceDesk Plus データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
オンプレミスDB やファイルからのAPI Server 使用(オプション)
オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。
ServiceDesk Plus のデータに接続したアプリを作成
OData エンドポイントをAPI Server に追加したら、ServiceDesk Plus のデータへのライブ接続が可能なアプリをBubble で作成できます。
Bubble API Connector を設定
まずは、Bubble からCData API Server にアクセスするためのAPI Connector を設定します。
- アプリ内で、Plugins タブをクリックして Add plugins をクリックします。
- 「API Connector」を検索して「Install」をクリックします。
- インストール後、「Add another API」ボタンをクリックしてAPI を設定します。
- API に名前を設定します。
- Authentication を「HTTP Basic Auth」に設定します。
- Username をAPI Server のユーザーに設定します([email protected])。
- Password を上記のユーザーのPAT に設定します。
- API Call を展開して、「GET」コマンドを選択してURL を先ほど設定したOData エンドポイントに設定します。
- 「Initialize call」ボタンをクリックしてレスポンスのデータ型を必要に応じて調整します。
- 必要な変更を加えた後、「SAVE」をクリックします。
App UI の設定
API Connector を設定したら、Bubble アプリでServiceDesk Plus のデータを取得できます。本記事では、Excel ライクなテーブルを表示できるUI コンポーネントでデータをリクエストします。
- Plugin タブで、「Excel-like HandsonTable」をインストールします。
- Design タブで、「Excel Table」をワークスペースに追加します。
- Excel Table のData source で、「Get data from an external API」を選択します。
- Type of content を「API Call value」に設定します。
- Data source を"API Server - <API Call の値>"(またはこれと同等な値)に設定します。
- 「Preview」をクリックしてServiceDesk Plus からデータが取得できたことを確認します。
この時点で、バックエンドAPI を設定する手間なくServiceDesk Plus のデータへのライブ接続を持つアプリケーションを開発できます。
クラウドアプリケーションからServiceDesk Plus のデータへのライブ接続
Bubble からServiceDesk Plus のリアルタイムデータに直接接続できるようになりました。これで、ServiceDesk Plus のデータを複製せずにより多くの接続とアプリを作成できます。
まとめと30日の無償評価版のご案内
このように ServiceDesk Plus 内のデータをBubble で利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、Bubble からのデータ参照を体感ください。