API platform by Workato - 新規APIリクエストトリガー

New API requestトリガーは、レシピエンドポイントのリクエストとレスポンスの構造を定義し、APIリクエストを受信するとジョブを作成します。

アクセス要件

APIレシピには、API platform機能へのアクセスが必要です。 Workatoのプラットフォーム＞API platformページにアクセスできない場合は、Customer Success Managerにお問い合わせください。

入力

Requestセクションの入力フィールドは、エンドポイントへのAPIリクエストの構造を定義します:

入力項目	説明
コンテンツタイプ	リクエストのデータ形式を定義します。 `application/json`、`text/plain`、または`multipart/form-data`を選択します。大きな添付ファイル（最大5GB）をアップロードするには、`multipart/form-data`を使用します。
リクエストヘッダー	リクエストヘッダーに含める必要があるパラメータを定義します。
リクエストスキーマ	リクエスト本文に必要な想定スキーマを定義します。

Responseセクションの入力フィールドは、エンドポイントが送信するレスポンスの構造を定義します:

入力項目

説明

コンテンツタイプ

レスポンスのデータ形式を定義します。空白のままにした場合、デフォルトでJSONになります。

レスポンスヘッダー

レスポンスヘッダーに含まれるパラメータを定義します。

レスポンス

エンドポイントに送信されたリクエストに対する可能なレスポンスを定義します。

このフィールドには、以下のサブフィールドがあります。

入力項目	説明
名前	レスポンスの名前。例: UnauthorizedまたはCreated
コード	レスポンスの種類を識別する、レスポンスに関連付けるHTTPステータスコード。例: Unauthorizedレスポンスは401ステータスコードに関連付けられます。
スキーマ	レスポンス本文に必要な想定スキーマを定義します。

バイナリコンテンツの処理

マルチパートデータには、画像やPDFファイルなどのバイナリデータが含まれる場合があります。これらのファイルがutf-8エンコーディング形式であることを確認する必要があります。 Workatoレシピの文字列処理はutf-8をサポートしています。

出力フィールド説明

コンテキスト

APIリクエストに関するメタデータ。

このフィールドには、以下のサブフィールドがあります。

出力フィールド	説明
呼び出し元ジョブID	リクエストに関連付けられたジョブのID。
呼び出し元レシピID	レシピから呼び出された場合、リクエストを送信したレシピのID。
呼び出し元IPアドレス	このレシピをエンドポイントとして呼び出しているクライアントのIPアドレス。
アクセスプロファイル	リクエストの実行に使用されたアクセスプロファイルに関する詳細。
APIクライアント	リクエストの実行に使用されたAPIクライアントに関する詳細を含みます。
JWTクレーム	JWTトークンが使用されている場合にのみ利用可能です。リクエストの認証に使用されたJWTクレームに関する詳細を含みます。

リクエスト

リクエストのコンテンツタイプと本文に関する詳細を含みます。

このフィールドには、以下のサブフィールドがあります。

出力フィールド	説明
コンテンツタイプ	リクエストのコンテンツタイプがRawの場合にのみ適用されます。リクエストの`Content-Type`ヘッダー値。
リクエスト本文（raw）	リクエストのコンテンツタイプが`Raw`の場合にのみ適用されます。リクエストの完全なraw本文。
リクエスト本文（JSON）	リクエストのコンテンツタイプが`JSON`の場合にのみ適用されます。リクエストスキーマで定義されたすべてのフィールドを含むJSONオブジェクト。

Last updated: