クライアントトークンでAPIエンドポイントを使ったフローの呼び出し

APIエンドポイントフローはWebhookとして登録され、固有のクライアントトークンによって保護されます。APIエンドポイントフローには、リクエスト元のサービスが呼び出しURLを介して適切なクライアントトークンを渡した場合にのみアクセスできます。呼び出しURLはフローエイリアスを使用して構築します。

フローを呼び出すと、フロー出力がレスポンスオブジェクトとして送信されます。

登録済みのWebhookを介してフローを呼び出すには、次の手順を使用します。

フローを作成する

既存のAPIエンドポイントフローについては、これら2つのフロー作成ステップをスキップできます。代わりに、フローでAPIエンドポイント(API Endpoint)イベントカードの下部に表示されているエンドポイント設定(Endpoint settings)アイコンAPI endpoint settings icon.をクリックします。

  1. Workflowsコンソールでフローを作成し、イベントを追加(Add event)をクリックします。

  2. フローを開始するためのアプリを選択(Pick an app to start your flow)ダイアログで、APIエンドポイント(API Endpoint)を選択します。

APIエンドポイント設定を構成する

  1. APIエンドポイント設定(API endpoint settings)ダイアログで、セキュリティレベルとしてクライアントトークンで保護(Secure with client token)を選択します。

  2. このオプションを選択すると、登録済みのWebhookを識別するためのクライアントトークン(Client token)が生成されます。この固有のクライアントトークンは、呼び出しURL(Invoke URL)フィールドと再開URL(Resume URL)フィールドにエイリアス値として自動的に追加されます。

  3. コピー(copy)をクリックして、呼び出しURL(Invoke URL)フィールドにURLを保存します。

  4. 閉じる(Close)jをクリックして、変更したエンドポイント設定を確定します。

APIエンドポイントフローをテストする

フローを呼び出すには、呼び出しURL(Invoke URL)(GET)に対してGET(POST)リクエストまたはPOST(Invoke URL)リクエストを実行します。リクエストの本文でデータを送信する必要がある場合は、POSTメソッドを使用します。

必要に応じて、以下のいずれかの方法でリクエストを認証します。

  • 指定したクライアントトークン(Client token)を、clientTokenクエリパラメーターを使って渡す。これはデフォルトの動作です。

  • 指定したクライアントトークン(Client token)を、x-api-client-tokenヘッダーの値として渡す。これは、最も安全なオプションです。ただし、clientTokenクエリパラメーターと併用しないでください。

関連項目

関数:APIエンドポイント(API Endpoint)

フローエイリアス

フロークライアントトークン