# SOAP API レシピの手順
自分自身のSOAP APIを作成する準備はできましたか？このガイドでは、HTTP接続を使用した例を通じて、手順を説明します。
私たちの目標は、オンプレミスでホストされているターゲットAPIを介してSOAPリクエストを解析し処理するAPIを作成することです。外部のビジネスパートナーや内部の関係者は、このエンドポイントを使用してデータにアクセスし消費することができますが、プライベートサーバー上でホストされているこのAPIに直接アクセスする必要はありません。
# ステップ1：レシピの作成
このステップでは、レシピを作成し、開始ポイントを選択します。
新しいレシピを作成し、名前を付けます。
レシピを含むフォルダを選択します。
開始ポイントとしてAPIエンドポイントの構築をクリックします。
ビルドを開始をクリックします。
APIエンドポイントの構築の開始ポイントを使用すると、Workatoは自動的に新しいAPIリクエストトリガーとAPIリクエストへのレスポンスアクションを持つレシピを作成します。
# ステップ2：レシピのトリガーを定義する
次に、エンドポイントのリクエストとレスポンスの構造を定義するために、新しいAPIリクエストトリガーのパラメータを定義します。トリガーの定義には2つのステップがあります：
# ステップ2.1：エンドポイントのリクエスト構造を定義する
このステップでは、エンドポイントへのリクエストに含まれるパラメータを定義します。
トリガーをクリックしてセットアップタブを開きます。
リクエストタブを開きます（既に開いている場合はスキップ）。
Content typeフィールドでText/XMLを選択します。
リクエストヘッダーセクションで、エンドポイントに送信されるリクエストのヘッダーに含めるパラメータを定義します。
# ステップ2.2：エンドポイントのレスポンス構造を定義する
リクエスト構造を定義した後は、エンドポイントのレスポンス構造に移ります。レスポンス構造は、SOAP APIレシピによって返される出力とそれに対応するフィールドを決定します。
例えば、エンドポイントが成功したAPIリクエストのレスポンスを返すようにしたい場合、それを行うレスポンス（200 - Success）を追加することができます。
このセクションでは、SOAPリクエストに未識別の操作が含まれている場合のエラーレスポンスも定義できます。
レスポンスタブを開きます（既に開いている場合はスキップ）。
Content typeフィールドでText/SOAPを選択します。
レスポンスヘッダーセクションで、エンドポイントから送信されるレスポンスヘッダーに含まれるパラメータを定義します。
レスポンスセクションで、レスポンスを追加を選択します。
レスポンス #1セクションで、成功したレスポンスの名前を指定します。
レスポンス #2セクションで、認証されていないレスポンスの名前を指定します。
HTTPステータスコードフィールドで、レスポンスコードが標準かカスタムかを設定します。
- 標準レスポンスを選択する場合、ピックリストからHTTPステータスコードを選択します。
- カスタムレスポンスを選択する場合、カスタムのHTTPステータスコードを入力します。2xxから5xxまでのレスポンスコードを指定できます。
# ステップ3：レシピにステップを追加する
レシピにステップを追加するには、以下の手順を実行します：
# ステップ3.1：XMLペイロードの解析と検査
WorkatoのSOAPツールを使用して、受信ボディを解析し、操作名を特定します。
操作名を検索して承認された操作のリストに受信リクエストが含まれていることを確認します。
# ステップ3.2：ターゲットアプリケーションにリクエストを送信
Ifブロックに、必要なアクションを追加します。この例では、オンプレミスでホストされているターゲットAPIにSOAPリクエストを送信するアクション（アプリ内のアクション > HTTP > リクエストの送信）を追加します。オンプレミスグループを介してリクエストを転送するHTTP接続を選択します。
アクションを定義したら、Returnアクションを選択します。
レスポンススキーマセクションで、オンプレミスAPIからのペイロードをレスポンスボディにマッピングします。
最後のステップは、リクエストに未承認の操作が含まれている場合に実行されるElseブロックを定義することです。Returnアクション（アプリ内のアクション > WorkatoのAPIプラットフォーム > APIリクエストへの応答）を選択し、Not foundレスポンスを選択します。
エラーレスポンスを使用すると、何かがうまくいかなかった場合にエンドポイントが有用な情報を提供し、より具体的なトラブルシューティングが可能になります。
SOAP APIレシピ
# ステップ4: 別のAPIレシピを作成してWSDLを返す
このSOAP APIを説明するWSDLを返す別のレシピを作成します。このWSDLは、WorkatoのFileStorageに保存することができます。
WSDL APIレシピ
# ステップ5: レシピを保存してテストする
進行中にレシピを保存してテストしてください！問題が発生した場合、トラブルシューティングが容易になるように、小さなステップでレシピを構築することをお勧めします。
# ステップ6: SOAP APIコレクションを作成する
2つのレシピを使用して新しいAPIコレクションを作成します。これにより、SOAPリクエストを処理するための最初のエンドポイントと、WSDLを返すための別のエンドポイントが作成されます。
SOAP APIコレクション
SOAP APIレシピの作成おめでとうございます！他のリソースでできることをチェックしてみてください：
Last updated: 2024/2/13 16:59:53