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

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

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

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

フローを作成する

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

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

  2. ［フローを開始するためのアプリを選択］ダイアログで、［API Endpoint（APIエンドポイント）］を選択します。

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

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

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

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

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

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

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

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

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

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

関連項目

関数：APIエンドポイント

フローエイリアス

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