API
最終更新
最終更新
連携機能パネルのAPIタブから、APIエンドポイントに対して送信するリクエストを作成できます。
送信先のAPIエンドポイントは、データソース メニューから登録します。詳しい手順は、 を参照してください。
編集中の管理画面で作成されたAPI名が表示されます。
API名をクリックすると、その内容が表示され、編集することができます。
入力したキーワードで、APIを絞り込みできます。
（例）get を入力すると、get_employees 、get_stocks ... などの、該当するAPIが表示されます。
操作したいAPIにマウスカーソルを載せると、操作アイコンが表示されます。このアイコンをクリックして、各種操作を行うことができます。
APIの一覧からAPI名をクリックすると、内容が表示されます。
APIを送信・実行するAPIエンドポイントを選択します。
APIを送信・実行する前に実行される処理を登録できます。
本番処理を実行する前の動作を、以下から選択できます。
アクション無し
実行前アクションを設定しません。すぐに本番処理が開始されます。
確認
本番処理を実行する前に、ユーザー確認モーダルを表示します。 モーダルの「確認」ボタンをクリックすると、本番処理が実行されます。
承認
本番処理を実行する前に、責任者に承認を求めることができます。 承認要件モーダルの「提出」ボタンをクリックすると、選択されたユーザーに承認依頼が届きます。承認されると、本番処理が実行されます。
前処理として、JavaScript プログラムを実行することができます。
トグルスイッチをONにすると、JavaScript プログラムの入力欄が表示されます。
前処理のJavaScriptでreturn した内容は、{{ APIリクエスト名.preData }} を用いて、本番処理のリクエストの設定で利用できます。
JavaScriptのテスト実行をクリックすると実行されます。
インスペクター画面のpreDataで結果の確認ができます。
APIエンドポイントに対して送信するリクエストの内容を設定します。
設定できる項目は以下の通りです。
HTTPメソッド
リクエストするメソッドを選択します。 GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS から選択します。
パス
APIエンドポイントのパスを指定します。
{{}} で囲んで、JavaScript の式を埋め込むことができます。
パラメーター
APIリクエストのURLパラメーターを設定します。
{{}} で囲んで、JavaScript の式を埋め込むことができます。
ヘッダー
APIリクエストのヘッダーを設定します。
{{}} で囲んで、JavaScript の式を埋め込むことができます。
Bodies Type
APIリクエストのボディデータのタイプを設定します。 None, JSON, GraphQL, Form-Data, w-xxx-urlcoded から選択します。 None 以外を選択した場合は、それぞれの項目に応じて入力欄が表示されます。
クッキー
APIリクエストに含めるCookie を設定します。
{{}} で囲んで、JavaScript の式を埋め込むことができます。
本番処理のAPIリクエストが送信・実行された後に実行する処理を登録できます。
後処理として、JavaScript プログラムを実行することができます。
トグルスイッチをONにすると、JavaScript プログラムの入力欄が表示されます。
本番処理のAPIリクエストの結果は、this.data で利用できます。
後処理のJavaScriptでreturn した内容は、{{ APIリクエスト名.data }} で参照できるようになります。
APIリクエストが成功した場合のアクションを設定できます。
APIリクエストが失敗した場合のアクションを設定できます。
パネル右上の「実行」ボタンをクリックすると、APIリクエストが送信・実行され、パネルの最下部に結果が表示されます。
パネル右上の「保存」ボタンをクリックすると、APIが保存されます。
キーワードフィルターの隣のをクリックすると、APIが追加されます。
をクリックすると、APIの名称を変更できます。
をクリックすると、APIが削除されます。
APIエンドポイントは、 メニューから登録します。
承認の設定手順については、 を参照してください。
をクリックすると、アクションエディタが開きます。
をクリックすると、アクションエディタが開きます。
アクションの設定については、 を参照してください。
