“APIに接続” ― システム連携サードパーティアプリケーションに対して行われるサービスリクエストであり、両方のアプリケーションが相互に通信して必要な情報を共有できるようにします。“APIに接続”システム連携を使用すると、サードパーティアプリケーションとの間でデータにアクセスして送信できます。これにより、次のアクションを実行できます。
- Get
- Post
- Put
- Patch
- Delete
APIに接続を構成してアクションを実行するは、次のステップに従います:
- 左側のペインには、システム連携セクションが表示されます。このセクションからビルダーにAPIに接続ステンシルをドラッグアンドドロップします。
- APIに接続ステンシルをクリックして、APIに接続ウィンドウを開きます。
- APIに接続ウインドウで、次の詳細を入力します。
- 名前―タスクの名前を入力
- タイプ―ドロップダウンリストからAPIタイプ(REST / SOAP)を選択します。
- システム連携モード – システム連携モードを選択。同期または非同期。
- URL―リクエストの定義をクリックして、サービスリクエストを定義します。タスクリクエストの定義ページが表示されます。「メソッドド」ロップダウン リストから、タスクに使用する HTTPメソッドを選択します。次を選択できます:
- POST ― サーバーにデータを送信するために使用されます。たとえば、HTMLフォームを使用して顧客情報、ファイルのアップロードなど。
- PUT ― ターゲットリソースのコンテンツを、送信されたコンテンツに置き換えます。
- PATCH ― ターゲットリソースのコンテンツに、送信されたコンテンツを追加します。
- DELETE ― 既存のターゲットリソースのコンテンツを削除します。
- GET ― 既存のターゲットリソースのコンテンツを戻します。
- URLフィールドにURLを指定します。
- 指定されたリクエストURLにアクセスする必要がある場合は、ヘッダータブで、ヘッダーをキーと値のペアとして指定します。
- リクエストをテストタブをクリック。
- テストをクリックして、指定されたHTTPヘッダーと、定義されている場合は本文パラメーターを使用してAPIリクエストURLを送信します。レスポンスはテキスト領域に表示されます。
- 保存をクリックして、テストレスポンスをサンプルレスポンスとして保存します。また、レスポンスを保存すると、リクエストの定義ページが自動的に終了します。
- コネクタを使用したアクセスセクションで、はい、URLはファイアウォールの背後にあり、コネクタは設定されていますチェックボックスをオン/オフにできます。
- APIに接続ウィンドウを閉じます。