SOAP APIレシピコレクション
SOAP APIレシピコレクションは、WorkatoのAPI platformを通じてSOAP 1.1または1.2サービスエンドポイントを公開します。 コレクション内の各オペレーションは、Web Services Description Language(WSDL)定義から自動生成された1つのAPIレシピにマッピングされます。
SOAP APIレシピコレクションを使用して、XML/SOAPプロトコルを必要とするレガシーエンタープライズシステムをサポートできます。 これにより、RESTに移行できないプラットフォームをモダナイズできます。
前提条件
SOAP APIレシピコレクションを作成する前に、次を確認してください:
- ワークスペースでプロジェクトを作成または選択済みであること。
- 次の要件を満たす有効なWSDLファイルがあること:
- ファイルが自己完結型であること。
- 外部ファイルを参照するために
wsdl:import、xsd:import、またはxsd:includeを使用していないこと。
SOAP APIコレクションの作成
SOAP APIコレクションを作成するには、次の手順を実行します。
Workatoアカウントにサインインします。
プラットフォーム>API platform>APIコレクションに移動します。
+ 新規コレクションを作成をクリックします。
コレクションタイプとしてAPIレシピコレクションを選択します。
APIレシピコレクションを選択
API typeドロップダウンメニューを使用してSOAP APIを選択します。
次へをクリックします。
Locationドロップダウンメニューを使用して、生成されたレシピを保存するプロジェクトを選択します。 Workatoは、この場所にWSDLオペレーションごとに1つのレシピを作成します。
.wsdlファイルをWSDL fileアップロード領域にドラッグアンドドロップするか、upload from deviceをクリックしてファイルを参照します。
WSDLファイルを選択
次へをクリックします。 WorkatoはWSDLファイルをアップロードして検証します。 成功メッセージにより、アップロードが完了したことが確認されます。
アップロード失敗
アップロードに失敗した場合は、Go backをクリックして前の手順に戻り、ファイルを再アップロードするか、別のファイルを試します。
WSDLファイルが前提条件セクションの要件を満たしていることを確認してください。
次へをクリックします。
WSDLから生成されたオペレーションのリストを確認します。 Workatoはすべてのオペレーションをインポートし、オペレーションごとに1つのレシピを作成します。
スキーマ検証
このエンドポイントに対して行われるすべてのリクエストは、デフォルトで定義済みスキーマに照らして検証されます。
任意です。 オペレーションのEdit detailsを展開して、次のフィールドを設定します:
Operation labelフィールドに人間が判読できる名前を入力します。 これはデフォルトでオペレーション名になります。
Request Nameの値を確認します。 これは、SOAPサービスがリクエストをこのオペレーションにルーティングするために使用する一意の識別子です。
Operation descriptionフィールドに短い概要を入力します。
Request timeout値を設定します。 デフォルト値は30秒、最大値は240秒です。
次へをクリックします。
Collection nameフィールドにわかりやすい名前を入力します。 例: Weather SOAP API。
バージョンフィールドにバージョン番号を入力します。
Descriptionフィールドに短い概要を入力します。
Create collectionをクリックします。 WorkatoはWSDLをリソースとして保存し、オペレーションごとに1つのレシピを生成します。
View API collectionをクリックして、アクセスを管理するか、エンドポイントを有効化します。
SOAP APIコレクションの管理
SOAP APIコレクションを作成した後、コレクションの概要ページからオペレーションの管理、クライアントアクセスの設定、およびWSDLのダウンロードを行えます。
プラットフォーム > API platform > APIコレクションに移動し、SOAP APIコレクションを選択して概要ページを開きます。
概要ページには次のタブがあります:
- Operations: コレクション内のオペレーションを表示および管理します。 各オペレーションには、名前、SOAPアクション、説明、および有効化ステータスが表示されます。
- Clients: コレクションにアクセスできるクライアントを管理します。
- Settings: コレクションパスやバージョンなど、コレクションレベルの設定を構成します。
右側のサイドバーには、コレクションタイプ、サービスURL、アクセス権を持つクライアント、および作成日が表示されます。 サービスURLはEnvironmentごとに自動生成されます。
SOAP APIコレクションの概要
WSDLのダウンロード
コレクションの概要ページの右上隅にあるDownload WSDLをクリックして、WSDLファイルをエクスポートします。 これはコレクションの現在の状態を反映しています。
WorkatoはWSDLを編集しませんが、新しいエンドポイントURLを生成し、すべてのマッピングと名前空間を変更せずに保持します。
プロジェクトのアセットタブのリソース詳細ページからWSDLをダウンロードすることもできます。 詳細については、WSDLアセット管理を参照してください。
WorkatoはWSDLを編集せず、生成します
オペレーション詳細の表示
Operationsタブからオペレーションを選択して、そのDetailsページを開きます。 詳細ページには、New SOAP API requestトリガーとRETURNアクションを含む自動生成されたレシピが表示されます。また、SOAPアクション、エンドポイントタイプ、説明、リクエストタイムアウト、および有効化ステータスを表示するサイドバーも表示されます。
オペレーション詳細の更新
各オペレーションのラベル、説明、SOAPアクション、リクエストタイムアウト、その他の詳細を更新できます。
オペレーションを編集するには、次の手順を実行します。
プラットフォーム > API platform > APIコレクションに移動し、SOAP APIコレクションを選択します。
リストからオペレーションを選択します。
Settingsタブに移動し、必要に応じてオペレーションフィールドを更新します。
保存をクリックして変更を適用します。
WSDLアセット管理
Workatoは、コレクション作成時にWSDLファイルをアップロードすると、選択したプロジェクトフォルダ内にリソースとして保存します。 このリソースは、プロジェクトのアセットタブで表示および管理できます。
WSDLリソースにより、Workatoは次を実行できます:
- WSDLオペレーションからAPIレシピとオペレーションスキーマを自動生成する
- 受信XMLペイロードを定義済みスキーマに照らして検証する
- バージョン履歴を追跡し、WSDLとリンクされたレシピの間の依存関係を管理する
リソース詳細ページでDownloadをクリックして、現在のWSDLファイルをエクスポートできます。
注意して使用
アップロード後にWSDLファイルやコレクション設定を編集することはできません。 WSDLの新しいバージョンをアップロードできますが、変更は既存のAPIコレクションやその生成済みレシピには適用されません。 アップロードする前に、WSDLに必要なすべてのオペレーションと仕様が含まれていることを確認してください。 コレクションの作成後は、レシピロジックのみを直接変更できます。
最終更新日: