SOAP APIレシピウォークスルー
独自のSOAP APIを作成する準備はできていますか。 このガイドでは、HTTPコネクションを使用する例を説明します。
目標は、オンプレミスでホストされているターゲットAPIを通じてSOAPリクエストを解析および処理するAPIを作成することです。 外部ビジネスパートナーと社内関係者は、このエンドポイントを使用して、プライベートサーバーでホストされているこのAPIに直接アクセスせずに、データにアクセスして利用できます。
ステップ1: レシピを作成する
このステップでは、レシピを作成し、その開始ポイントを選択します。
新しいレシピを作成し、名前を付けます。
レシピを格納するフォルダを選択します。
開始点としてAPIエンドポイントを構築をクリックします。
構築を開始をクリックします。
開始点でAPIエンドポイントを構築を使用すると、Workatoは新規APIリクエストトリガーとAPIリクエストへのレスポンスアクションを含むレシピを自動的に作成します。
ステップ2: レシピのトリガーを定義する
次に、新規APIリクエストトリガーのパラメーターを定義して、エンドポイントのリクエストとレスポンスの構造を定義します。 トリガーの定義には2つのステップがあります:
ステップ2.1: エンドポイントのリクエスト構造を定義する
このステップでは、エンドポイントに対して行われるリクエストのパラメーターを定義します。
トリガーをクリックして、その設定タブを開きます。
まだ開いていない場合は、リクエストタブを開きます。
コンテンツタイプフィールドでテキスト/XMLを選択します。
リクエストヘッダーセクションで、エンドポイントに送信されるリクエストのヘッダーに含めるパラメーターを定義します。
ステップ2.2: エンドポイントのレスポンス構造を定義する
リクエスト構造を定義したら、エンドポイントのレスポンス構造に進みます。 レスポンス構造は、SOAP APIレシピによって返される出力とそれぞれのフィールドを決定します。
たとえば、エンドポイントから成功したAPIリクエストのレスポンスを返す場合は、そのためのレスポンス（200 - Success）を追加できます。
このセクションでは、SOAPリクエストに識別されていないオペレーションが含まれる場合のエラーレスポンスも定義できます。
まだ開いていない場合は、レスポンスタブを開きます。
コンテンツタイプフィールドでテキスト/SOAPを選択します。
レスポンスヘッダーセクションで、エンドポイントから送信されるレスポンスヘッダーに含まれるパラメーターを定義します。
レスポンスセクションで、レスポンスを追加を選択します。
レスポンス#1セクションで、成功レスポンスの名前を指定します。
レスポンス#2セクションで、未承認レスポンスの名前を指定します。
HTTPステータスコードフィールドで、レスポンスコードを標準またはカスタムのどちらにするかを設定します。
- 標準レスポンスを選択した場合は、ピックリストからHTTPステータスコードを選択します。
- カスタムレスポンスを選択した場合は、カスタムHTTPステータスコードを入力します。 2xxから5xxまでのレスポンスコードを指定できます。
ステップ3: レシピにステップを追加する
レシピへのステップの追加は、次のステップで構成されます:
ステップ3.1: XMLペイロードを解析および検査する
XMLツール by Workatoを使用してXMLボディを解析し、オペレーション名を抽出します。
ルックアップ テーブルから操作名を検索して、受信リクエストが承認済み操作のリストに含まれていることを確認します。
ステップ3.2: ターゲットアプリケーションにリクエストを送信する
Ifブロックで、目的のアクションを追加します。 この例では、オンプレミスでホストされているターゲットAPIにSOAPリクエストを送信するアクションを追加します。 （アプリ内のアクション＞HTTP＞リクエストを送信）オンプレミスグループを通じてリクエストを転送するHTTPコネクションを選択します。
アクションの定義が完了したら、返すアクションを選択します。
レスポンススキーマセクションで、オンプレミスAPIからのペイロードをレスポンス本文にマッピングします。
最後のステップは、リクエストに未承認の操作が含まれる場合に実行されるElseブロックを定義することです。 返却アクション（Action in an app > APIプラットフォーム by Workato > Respond to API request）を選択し、Not foundレスポンスを選択します。
エラーレスポンスを使用すると、問題が発生したときにエンドポイントから有用な情報を提供でき、より的を絞ったトラブルシューティングが可能になります。
SOAP APIレシピ
ステップ4: WSDLを返す別のAPIレシピを作成する
このSOAP APIを記述するWSDLを返す別のレシピを作成します。 このWSDLは、Workato FileStorageを使用してWorkatoに保存できます。
WSDL APIレシピ
ステップ5: レシピを保存してテストする
作業しながらレシピを保存してテストしてください。 発生した問題のトラブルシューティングを容易にするために、小さなステップでレシピを構築することをお勧めします。
ステップ6: SOAP APIコレクションを作成する
2つのレシピを使用して、新しいAPIコレクションを作成します。 これにより、2つのエンドポイントが作成されます。1つ目は各SOAPリクエストを処理し、もう1つはWSDLを返します。
SOAP APIコレクション
SOAP APIレシピの作成が完了しました。 これらの他のリソースで実行できるその他の内容を確認してください:
Last updated: