外部APIリクエスト
あらゆるAPIと通信し、あらゆるサービスを統合することができます。
外部APIリクエストでは、リクエストテンプレートを定義し、ビジネスプロセス内から任意のAPIへの呼び出しをトリガーすることができます。これを使えば、たとえマーケットにそのモジュールが存在しなくても、あなたのプロジェクトをサードパーティのサービスに接続することができます。
定義
接続したいサービスプロバイダのAPIドキュメントにある、リクエストの構成方法の仕様を参照してください。
- 新しいリクエストテンプレートを定義するには、サイドバーの「ビジネスロジック」タブ (1) から「外部 API リクエスト」タブ (2) に切り替え、「新しい API リクエスト」(3) をクリックします。
3.3. リクエストの HTTP メソッドと URL を選択します。
4.URLパラメータ、クエリーパラメータ（GETリクエストのみ）、ヘッダー、リクエスト本体を定義します。パラメータ名（1）、パラメータタイプ（2）を入力し、「パラメータ追加」をクリックします（3）。
これらのパラメーターの実際の値は、リクエストが発生したビジネスプロセスの実行時に定義されます。
URLパラメータとクエリパラメータの違いについては、こちらをご覧ください。しかし、規格に関係なく、あなたが接続したいサービスプロバイダのAPIドキュメントが、リクエストの作成方法に関する最良の情報源となります。
また、サンプルJSONを入力することで、リクエストヘッダや本文を自動入力することができ、必要なパラメータはすべてシステムが自動的に作成します。
タブごとに新しいパラメータを追加する必要はありません。リクエストによっては、たとえばURLパラメータ、ヘッダー、ボディがまったく含まれていない場合もあります。
リクエストにオブジェクトが含まれている場合（例：車→色、サイズなど）、これらのオブジェクトを後でビジネスプロセスで処理するために、仮想モデルを作成する必要があります。そのためには、パラメータタイプのセレクタで "モデル "を選択し、必要な子要素を導入します。オブジェクトは何度でも入れ子にすることができ（つまり、オブジェクトの中にオブジェクトを入れる）、仮想モデル配列を作成することができます。オートフィルを使用した場合、このプロセスは自動的に完了します。
5.5. "設定 "タブで、SSL認証、タイムアウト、エラー処理など、リクエストの設定を変更します。
7.7. 「リクエストの保存」をクリックし、リクエストテンプレートを保存します。
使用方法
新しいリクエストを定義して保存すると、ビジネスプロセスエディターで新しいブロックが利用可能になり、それをトリガーにすることができます。
リクエストに追加したいすべてのコンポーネント（URLとクエリパラメータ、ヘッダー、ボディ）をデータモデルとして提供する必要があり、これらのブロックを使用して作成することができます。出力では、フォーマットされたレスポンスのボディ、ヘッダー、レスポンスステータスを抽出することができるようになります。これらのモデルは、これらのブロックを使って拡張することができます。
リクエストが正しくトリガーされるために、すべてのデータ入力を接続する必要はありません。例えば、URL パラメータのないリクエストがあった場合、そのモデルを作成して接続する必要はありません。
定義した仮想モデルごとに、ビジネスプロセスエディタに新しいブロックが2つ追加され、モデルを作成・拡張することができます。
モニタリング
APIリクエストを発生させるたびに、リクエストの種類とアドレス、リクエストボディ、レスポンスのHTTPステータスコード、レスポンスボディをログに出力します。Write to Logブロックを使えば、レスポンスボディの特定のフィールドやレイテンシーなど、他の情報もログに出力することができます。
