ストリーミング API 開発者ガイド
jREST を使用してイベントを生成する
Streaming Channel Push REST API リソースを使用して、チャネル登録者に対してイベント通知を生成します。
ワークベンチを使用して、REST API にアクセスし、通知を送信します。ワークベンチは、無料のオープンソースのコミュニティサポートツールです (ワークベンチのヘルプページを参照)。Salesforce は、デモ目的でのみワークベンチのホスト型インスタンスを提供しています。このワークベンチのホスト型インスタンスを本番データベースのデータへのアクセスに使用することはお勧めしません。ワークベンチを本番データベースに使用する場合は、各自で所有するリソースを使用してワークベンチをダウンロード、ホスト、および設定してください。ワークベンチは、https://github.com/forceworkbench/forceworkbench からダウンロードできます。
- ブラウザで、https://workbench.developerforce.com/login.php に移動します。
- [Environment (環境)] で [Production (本番)] を選択します。
- [API バージョン] で [57.0] を選択します。
- サービスの利用規約に同意し、[Login with Salesforce (Salesforce でログイン)] をクリックします。
- データベースへの接続が確立されると、[Select (選択)] ページが表示されます。
- をクリックし、SELECT Name, ID FROM StreamingChannel の SOQL クエリを行って、StreamingChannel ID を検索します。/u/notifications/ExampleUserChannel の StreamingChannel ID をコピーします。
- をクリックします。
- URL 項目に「/services/data/[v<API バージョン>]/sobjects/StreamingChannel/[<ストリーミングチャネル ID>]/push」と入力します。[v<API バージョン>] は v57.0 で、[<ストリーミングチャネル ID>] は、ステップ 6 で検索した StreamingChannel の ID です。
- [POST] を選択して、HTTP メソッドを設定します。[Request Body (リクエストボディ)] に、以下の「POST REST リクエストボディの例」で示す JSON リクエストボディを入力します。
- Java 登録者クライアントの実行中に [Execute (実行)] をクリックします。これで、チャネルのすべての登録者にイベントが送信されます。Java クライアントで、ペイロードテキストを含む通知が受信されます。REST メソッド応答は、イベントが送信された登録者数を示します (この場合は、すべての登録者にイベントを送信するよう設定されているため、–1 になります)。
汎用ストリーミングを使用して、通知が登録者に正常に送信されました。すべての登録者に送信するだけでなく、登録ユーザのリストを指定して特定の登録者に通知を送信することができます。また、Streaming Channel Push REST API リソースの GET メソッドを使用して、チャネルのアクティブな登録者のリストを取得することもできます。
例
POST REST リクエストボディの例