APIエンドポイントのテスト ​

エンドポイントに対応するAPIレシピが実行中であることを確認します。 これは、レシピを開始するか、レシピのテストモードを有効にすることで実行できます。

APIレシピコレクションページから、テストするエンドポイントを開きます。

レシピベースのエンドポイントは、テストする前にアクティブにする必要があります。 エンドポイントをまだアクティブにしていない場合は、ページ右上の非アクティブトグルを選択してアクティブに変更します。

APIレシピエンドポイントをアクティブ化

エンドポイントのアクティブ化の詳細については、エンドポイントのアクティブ化または非アクティブ化を参照してください。

パラメーターセクションの右側にある試すボタンを選択します。

APIレシピエンドポイントの試すボタン

必要なパス、クエリ、または本文のパラメーターをパラメーターセクションに入力します。

次のスクリーンショットは、必須のusernameパスパラメーターが入力されたレシピエンドポイントを示しています:

レシピエンドポイントのパスパラメーターの入力

実行を選択してテストリクエストを送信します。

次のレシピエンドポイントのスクリーンショットは、200成功コードを含むテストレスポンスを示しています:

成功したテストレスポンス

curl -X 'GET' \
  'https://api.na.workato.com/exampleuser/subscription-api-v1/user/rsloan' \
  -H 'accept: application/json' \
  -H 'api-token: 1234567890abcdefgh'

対応するレシピのジョブタブを表示して、実行したばかりのテストジョブを確認します。 詳細を確認するには、ジョブを選択します。

まだ作成していない場合は、APIクライアントを作成します。

新しいアクセスプロファイルを作成するか既存のアクセスプロファイルを編集して、テストするエンドポイントを含むAPIプロキシコレクションへのアクセス権をAPIクライアントに付与します。

APIプロキシコレクションページから、テストするエンドポイントを開き、テストタブに移動します。

パラメーターセクションの試すボタンを選択します:

APIプロキシエンドポイントの試すボタン

必要なパス、クエリ、または本文のパラメーターをパラメーターセクションに入力します。

次のスクリーンショットは、必須のorderIdパスパラメーターが値1に設定されたプロキシエンドポイントを示しています:

プロキシエンドポイントのパスパラメーターの入力

認証ボックスで、トークンを編集ボタンを選択します:

トークンを編集ボタンを選択

認証方法選択リストから認証方法を選択し、クライアントのアクセストークンまたは認証トークンをトークンフィールドに入力します。

トークンを設定を選択して認証トークンを確認します。

実行を選択してテストリクエストを送信します。

次のプロキシエンドポイントのスクリーンショットは、200成功コードとダウンロード可能なレスポンス本文を含むテストレスポンスを示しています:

成功したテストレスポンス

curl -X 'GET' \
  'https://api.na.workato.com/exampleuser/store/order/1' \
  -H 'accept: application/json' \
  -H 'api-token: 1234567890abcdefgh'