# API レシピ - Raw コンテンツ処理用にエンドポイントを構成する

コーラブルレシピを使用する場合

このガイドは API エンドポイントとしてセットアップされているコーラブルレシピにも適用できます。

注 : コーラブルレシピは廃止予定です。既存のコーラブルレシピは引き続き機能しますが、新たに作成することはできなくなります。このガイドでは API プラットフォームコネクターを使用します。このコネクターはコーラブルレシピ内の API 機能とまったく同様に動作します。

API プラットフォームでは、Raw コンテンツを受け付けるように API レシピを構成できます。これによって、XML/SOAP など、より多くのデータタイプをワークフローに統合できるようになります。

このガイドでは、Raw コンテンツを受け付ける API エンドポイントの作成手順を説明します。

# 前提条件

このガイドのステップを実行するには、以下のことが必要になります。

API プラットフォーム機能を利用できる。 これはアドオン機能です。詳細は、Workato のカスタマーサクセスマネージャーまでお問い合わせください。
API プラットフォームに対する権限。

# ステップ1 : API レシピを作成する

Workato アカウントにサインインします。

開始オプションの [Build an API endpoint] を使用してレシピを新規作成します。これにより、API プラットフォーム - 新規 API リクエストトリガーを含むレシピが作成されます。

トリガーの [Request] セクションの [Content type] として [text/plain] を選択します。これによって、エンドポイントは送信されるあらゆるデータタイプを受け付けられるようになります。

トリガーの [Response] を、次のように設定します。

[Content type] として [text/plain] を選択します。

[Response] セクションに、エンドポイントが応答に使用できるレスポンスを追加します。たとえば、Success レスポンスは、HTTP のステータスコード 200 - OK を使って応答できます。

必要に応じて、エンドポイントのその他のパラメータを定義します。

# ステップ2 : リクエスト本文を解析する

このステップは任意です。

エンドポイントが受信するデータをデータピルとして使用する必要がない場合は、ステップ3に進んでください。

エンドポイントが受信するデータを個別のデータピルとして使用する場合は、Workato のデータパーサーを使用できます。Workato のパーサーは JSON のパースに加えて、CSV、XML、YAML にも対応しています。

たとえば、今回作成するエンドポイントは fileId プロパティを含む XML コンテンツを受信します。fileId は Google Drive からファイルを取得するために使用します。 XML パーサー を使用すると、リクエスト本文を解析し、そのデータを後続のステップで使用可能なデータピルへと変換できます。

[App] で必要なパーサーを選択して、レシピにアクションステップを追加します。この例で選択するのは、 [XML parser] です。

アクションの入力として、 サンプルドキュメント を指定します。

アクションの [Document] フィールドに、トリガーの出力からの [Request body (raw)] データピルを追加します。

# ステップ3 : レスポンス本文を定義する

このステップでは、ステップ1で作成したレスポンスのレスポンス本文を定義します。

注 : エンドポイントで複数のレスポンスを用意する場合、レスポンスの種類ごとに、このセクションのステップを繰り返す必要があります。

レシピステップとして API プラットフォーム - API リクエストに対する応答アクションを追加します。

[Response] メニューで、ステップ1で作成したレスポンスを選択します。

[Body] フィールドに、エンドポイントがレスポンス本文で返すデータを追加します。

# ステップ4 : API プラットフォームエンドポイントを作成する

この最後のステップでは、API レシピを API プラットフォーム内のエンドポイントとして公開します。これによって、本番環境にリリースする前にレシピをテストし、予想通りに動作することを確認できるようになります。

[API platform] > [API collections] に移動します

必要に応じて API コレクションを作成します。

コレクションを作成したら、新規 API エンドポイントの構成ガイドに示されたステップを実行して、レシピをエンドポイントとして追加します。

以上です。エンドポイントを API コレクションに追加すれば、そのエンドポイントを Raw コンテンツでテストできます。

REST エンドポイントを Raw コンテンツでテストする

Last updated: 2023/8/31 1:07:14