API

連携機能パネルのAPIタブから、APIエンドポイントに対して送信するリクエストを作成できます。

送信先のAPIエンドポイントは、データソース メニューから登録します。詳しい手順は、API を参照してください。

API一覧

編集中の管理画面で作成されたAPI名が表示されます。

API名をクリックすると、その内容が表示され、編集することができます。

キーワードフィルター

入力したキーワードで、APIを絞り込みできます。

(例)get を入力すると、get_employeesget_stocks ... などの、該当するAPIが表示されます。

APIの操作

操作したいAPIにマウスカーソルを載せると、操作アイコンが表示されます。このアイコンをクリックして、各種操作を行うことができます。

APIの追加

APi名の変更

APIの削除

APIの編集

APIの一覧からAPI名をクリックすると、内容が表示されます。

データソースの選択

APIを送信・実行するAPIエンドポイントを選択します。

APIエンドポイントは、データソース メニューから登録します。

前処理

APIを送信・実行する前に実行される処理を登録できます。

実行前アクション

本番処理を実行する前の動作を、以下から選択できます。

承認の設定手順については、承認フローを作成 を参照してください。

JavaScript

前処理として、JavaScript プログラムを実行することができます。

トグルスイッチをONにすると、JavaScript プログラムの入力欄が表示されます。

前処理のJavaScriptでreturn した内容は、{{ APIリクエスト名.preData }} を用いて、本番処理のリクエストの設定で利用できます。

JavaScriptのテスト実行をクリックすると実行されます。

インスペクター画面のpreDataで結果の確認ができます。

本番処理

APIエンドポイントに対して送信するリクエストの内容を設定します。

設定できる項目は以下の通りです。

後処理

本番処理のAPIリクエストが送信・実行された後に実行する処理を登録できます。

JavaScript

後処理として、JavaScript プログラムを実行することができます。

トグルスイッチをONにすると、JavaScript プログラムの入力欄が表示されます。

本番処理のAPIリクエストの結果は、this.data で利用できます。

後処理のJavaScriptでreturn した内容は、{{ APIリクエスト名.data }} で参照できるようになります。

成功時

APIリクエストが成功した場合のアクションを設定できます。

失敗時

APIリクエストが失敗した場合のアクションを設定できます。

アクションの設定については、アクションエディタ を参照してください。

実行

パネル右上の「実行」ボタンをクリックすると、APIリクエストが送信・実行され、パネルの最下部に結果が表示されます。

保存

パネル右上の「保存」ボタンをクリックすると、APIが保存されます。

最終更新