Indeed Real-time APIの始め方

Indeed Real-time APIを使ってみましょう。

 

はじめに

Indeed Real-time APIを使用して、リアルタイムのサーバー送信イベント（SSE）をストリーミングします。

Indeed Real-time APIをサブスクライブすると、フロントエンドアプリケーションは外部ソースによってトリガーされたサーバー送信イベントを受信し、リアルタイムで更新できます。例えば、Indeed Real-time APIを使用すると、チャットスレッドで他のユーザーがメッセージを送信した際に、新しいメッセージを即座に表示できます。ユーザーがエンドポイントにGETリクエストを行うと、バックエンドサービスがストリーミングするサーバー送信イベント（SSE）をサブスクライブします。

チャットで新しいメッセージが送信されると、イベントが公開されます。Indeed Real-time APIをサブスクライブしているフロントエンドアプリケーションはこのイベントを受信し、スレッドを更新して新しいメッセージを表示できます。

このイベントにはheartbeat、connection-metadata、realtime-connection-config、message-updateがあります。Indeed Real-time APIイベントを参照してください。

Indeed Real-time APIへのオンボーディング

Indeed Real-time APIエンドポイントを使用するには、Indeed PLUS開発者がアプリケーションのドメインを信頼できるドメインとしてIndeedのサービスに追加する必要があります。

認可コード付与タイプ（3-legged OAuth）の手順

Indeed以外のドメインからのリクエストは、認可コード付与タイプ（3-legged OAuth）を使用する必要があります。

リクエスト

バックエンドサービスがストリーミングするサーバー送信イベント（SSE）をサブスクライブするには、呼び出し元がIndeed Real-time APIエンドポイントにGETリクエストを行います。GETリクエストには、Bearer認証スキームを使用してAuthorizationヘッダーにアクセストークンを含める必要があります。

イベントタイプでレスポンスをフィルタリングするには、eventTypesクエリパラメータにカンマ区切りのイベントタイプリストを指定します。デフォルトでは、APIはすべてのイベントをストリーミングします。

レスポンス

レスポンスオブジェクトのレスポンスコードは、操作の成功または失敗を示します。

Real-time APIレスポンスコード

レスポンス コード		説明
200	成功	成功したレスポンスには以下のフィールドが含まれます。 フィールド 型 説明 uuid uuid 重複排除のための一意のID。このUUIDには、エンドツーエンドのレイテンシを測定するためのエンコードされたタイムスタンプが含まれています。 eventType string イベントをフィルタリングするためのクライアント指定のイベントタイプ。 payload string 任意。イベントに関する追加情報を含む、文字列としてシリアライズされたクライアント指定のJSONオブジェクト。 eventTime int64 イベントが発生したタイムスタンプ（エポックからのミリ秒単位）。デフォルトはイベントがトリガーされた時刻。
400	エラー	認証情報が正しくないためにエラーが発生しました。OAuthエラーのトラブルシューティングを参照してください。

 

このページは役に立ちましたか？