Skip to main content

 

拡張および連携

 

OutSystems

REST APIを利用する

別のシステムの情報を取得または操作する必要がある場合、そのシステムがそのエフェクト用のREST APIを提供していれば、アプリケーションでREST APIを利用できます。
まず、使用するREST APIのドキュメントを調べ、仕組みを理解してください。以下の情報を収集する必要があります。

  • ベースURL
  • セキュリティ/認証要件
  • メソッド定義(HTTPメソッド、URLパス、レスポンス形式)

セキュリティ

各REST APIには、アカウントの作成、APIキーの登録、あるいはトークンの使用を暗黙に定義する可能性のある独自のセキュリティおよび認証プロセスのモデルがあります。OutSystemsでREST APIを利用するには、プロバイダのセキュリティモデルを理解し、それに従う必要があります。

REST APIとREST APIメソッドを定義する

REST APIのメソッドを利用するには、REST APIのドキュメントから必要なすべての情報を収集した後、以下の手順を実行します。

  1. [Logic]タブで、Integrationsフォルダを開きます。

  2. REST要素を右クリックし、[Consume REST API...]を選択します。

  3. 表示されたダイアログで、以下のように単一のメソッドの追加を選択します。

    利用するREST APIがSwagger仕様に準拠している場合は、[ADD ALL METHODS]を選択するとすべてのAPIメソッドをワンステップで追加できます。それ以外の場合は、各メソッドを個別に追加する必要があります。

  4. メソッドのURLに関する情報を入力します。中カッコで囲んだパラメータを、メソッドの入力パラメータのURLに含めることができます。

    例:
    GET https://api.example.com/Portal/rest/Contacts/GetAll
    GET https://api.example.com/Portal/rest/...ts/Get?Id={Id}
    POST https://api.example.com/Portal/rest/Contacts/Create

  5. 利用しているREST APIが認証または特定のヘッダーを必要とする場合は、[Headers/Auth]タブを開き、必要な情報を入力します。

  6. リクエストとレスポンスに関する情報を入力します。APIに対するテストを実行してテスト結果を使用すると非常に簡単です。[Body]タブの[Request]と[Response]フィールドに、JSONストラクチャまたはプレーンテキストの例を直接追加することもできます。[Test]タブを開きます。メソッドのURLにパラメータがある場合は、テストを実行するためにパラメータ値を挿入する必要があります。

    POSTやPUTなどの操作メソッドについては、Body ContentのRequestに対応するリクエストストラクチャを入力してください。

  7. [Test]をクリックします。テストに成功すると、[Test]タブの[Response]領域にメソッドのレスポンスが表示されます。[Response]領域の[COPY TO RESPONSE BODY]をクリックし、その情報を[Body]タブのResponseに入力します。必要なフィールドだけを残します。([POST]や[PUT]などの)操作メソッドについては、[Request]領域で[COPY TO RESPONSE BODY]を押してRequestと同様の手順を実行します。

    通常、一般的なフィールドはこの方法で取得できます。使用可能なフィールドすべての詳細については、APIのドキュメントをご覧ください。

  8. [Body]タブでリクエストとレスポンスの情報が正しいかどうか確認し、[OK]をクリックします。

この時点で、OutSystemsが自動的に実行している事項を確認します。

  • REST APIの作成
  • 対応する入出力パラメータを持つREST APIメソッドの作成
  • 対応する入出力パラメータを保持するストラクチャの作成
  • OutSystemsのデータ型へのRESTデータ型のマッピング

REST-consume-8.png

REST-consume-11.png

アプリケーションでREST APIメソッドを使用する

OutSystemsは、Service Studioで作成したアクションと同じセマンティクスを使用して、REST APIによって公開されているメソッドをOutSystemsのアクションに変換します。

これで、アプリケーションで新しく作成されたメソッドを、他のサーバーアクションと同様に使用できるようになりました。

  1. REST APIメソッドを使用するアクションフローに移動します。
  2. [Logic]タブで、IntegrationsフォルダとREST要素を開きます。
  3. REST APIを開き、REST APIメソッドをアクションフローにドラッグします。

  4. 他のアクションの場合と同様に、メソッドの出力パラメータを使用します。

  • Was this article helpful?