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

詳細情報をご希望ですか?

製品について詳細情報や無償トライアルをご案内します:

API Server



API Server を使ってSurveyMonkey データの仮想OData API エンドポイントを作成して、OutSystems からSurveyMonkey データを使ったアプリを作成する方法。

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、API Server を経由して OutSystems からSurveyMonkey に連携するアプリを作成する方法を説明します。

API Server の設定

次のステップに従い、SurveyMonkey に連携するセキュアな REST API サービスを立ち上げます。

  1. API Server はサーバー上で稼働します。Windows 版は、製品に組み込まれているスタンドアロンのサーバーかIIS に配置して稼働させることができます。Java 版では、Java servlet コンテナにAPI Server のWAR ファイルを配置します。 デプロイの詳細は製品ヘルプを参照してください。API Server を Microsoft AzureAmazon EC2Heroku にデプロイする方法はKB に記事があります。
  2. API Server の管理コンソールで「設定」→「接続」から新しい接続を追加します。
  3. SurveyMonkey のアイコンがデフォルトのAPI Server の接続先にない場合には、API Server がJava 版の場合はJDBC Drivers、API Server がWindows 版の場合はADO.NET Data Providers からSurveyMonkey ドライバーをAPI Server と同じマシンにインストールして、API Server を再起動します。
  4. SurveyMonkey への接続に必要な認証情報を入力します。接続のテストを行い、接続を確認して、設定を保存します。
  5. SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

    SurveyMonkey への接続に使用できる認証方法は2つあります。

    • プライベートoauth アプリケーションを登録するときに、個人用アクセストークンを使用します。
    • パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

    個人用アクセストークンの使用

    個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、Creating a Custom OAuth App の手順に従って、次の接続プロパティを設定します。

    • OAuthAccessToken:アプリケーション設定で生成されたAccessToken に設定。
    • InitiateOAuth:OFF に設定。

    OAuth の使用

    本製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的にEmbedded Credentials を使用して接続します。

    独自のカスタムOAuth アプリを使用したい場合は、Custom Credentials を参照してください。

  6. 接続を確立後、「設定」→「リソース」の画面でテーブル一覧からREST API として公開するエンティティを選択します。
  7. 最後に「設定」→「ユーザー」からAPI にアクセスできるユーザーの認証設定を行います。API Server はトークンでの認証を行うことができます。 IP アドレスでAPI へのアクセスを制限することも可能です。デフォルトではローカルマシンからのアクセスのみが許可されています。SSL の設定も可能です。

OutSystems にAPI Server のコネクションを追加

続いてAPI Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてAPI Server に接続します。

  1. 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。
  2. 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し
  3. 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。
  4. すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。
  5. これで API Server へのLogic を登録できました。
  6. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
  7. なお、これだけでは認証が通らないので、先程 API Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。

一覧画面を作成

それでは実際に API Server と連携した画面を作成していきましょう。

  1. 「Interface」タブに移動して「Add Screen」をクリックします。
  2. Screenのテンプレートは「Empty」で進めます。
  3. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したAPI Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
  4. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から API Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
  5. そして、「Fetch Data from Other Source」のフローにAPI Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
  6. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
  7. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
  8. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
  9. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
  10. これだけで、API Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
  11. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
  12. 一覧画面が表示されて、以下のようにAPI Server 経由で取得したSurveyMonkey のデータがきれいに表示されました。

クラウドアプリケーションからSurveyMonkey データにOData API アクセスを実現

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