カスタムAPI呼び出し

このピースでできること

  • ContractS CLM APIの特定のエンドポイントへのカスタムAPIコールを実行します。
  • 標準アクションでは対応していないエンドポイントへのリクエストを自由に実行できます。

ContractS CLM の接続方法

workrun と ContractS CLM を接続するには、ContractS CLM の API キー が必要です。

ステップ 1:API キーを取得する

  1. ContractS CLM に管理者権限のユーザーでログインします。
  1. 画面右上のアカウントメニューから 「会社設定」 を開きます。
  1. 「API機能」 欄に表示される API キーをコピーします。
      • API キーが未発行の場合は、ContractS 社の担当者へ利用申し込みが必要です。

ステップ 2:workrun に接続を追加する

  1. workrun で ContractS CLM のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「APIキー」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「環境」 で接続先を選択します(通常は「本番環境(Production)」を選択してください)。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. URL(必須)

  • リクエスト先のURLを入力します。完全なURLまたはベースURLからの相対パスのどちらでも指定できます。認証ヘッダー(x-api-key)は接続設定から自動的に挿入されます。

2. メソッド(必須)

  • HTTPメソッドを選択します。GET・ POST・ PUT・ PATCH・ DELETEから選択できます。

3. ヘッダー(任意)

  • リクエストに追加するヘッダーを設定します。認証ヘッダーは接続から自動的に注入されるため、追加のヘッダーが必要な場合に使用します。

4. クエリパラメータ(任意)

  • URLに付与するクエリパラメータを設定します。キーと値のペアで入力します。

5. ボディ(任意)

  • POST・PUT・PATCHリクエスト時に送信するボディデータをJSON形式で入力します。

6. 失敗時にエラーにしない(任意)

  • ONにすると、APIリクエストが失敗してもフローを継続します。APIエラーでフローを止めたくない場合に使用します。