APIエンドポイントフローの呼び出し
API Endpoint(APIエンドポイント)は、外部ソースの変化によってトリガーできるフローのタイプです。
接続アプリケーションに関連付けられるイベントによって開始されるフローとは異なり、これらのフローはいつでもトリガーできます。唯一の要件は、外部のクライアントが有効なセキュリティ資格情報を使って指定のエンドポイントを呼び出すことです。
外部クライアントがエンドポイントを呼び出すと、フローが実行され、クライアントはそのフロー実行からの出力を受信します。
APIエンドポイントは2つの方法で公開できます。
- Exposed as a Webhook(Webhookとして公開):Webhookとして公開されるAPIエンドポイントには、HTTPリクエストを行うクライアントが適切なクライアントトークンを呼び出しURLに渡す場合にのみアクセスできます。呼び出しURLは、フローのエイリアスを使って作成されます。クライアントトークンとフローのエイリアスの詳細については、「フロークライアントトークン」と「フローのエイリアス」をご覧ください。
- Exposed as a Public Service(公開サービスとして公開):公開サービスとして公開されるAPIエンドポイントフローは、呼び出しURLを使って誰でも利用できます。呼び出しURLは、フローのエイリアスを使って作成されます。
APIエンドポイントの公開方法は、[API endpoint settings(APIエンドポイントの設定)]ダイアログで変更できます。このダイアログを表示するには、API Endpointイベントカードの下部にある[Endpoint settings(エンドポイントの設定)]アイコン(</>)をクリックします。