Indeed Real-time APIの始め方
Indeed Real-time APIを使ってみましょう。
概要
#Indeed Real-time APIを使用すると、サーバー送信イベント(SSE)をフロントエンドアプリケーションにストリーミングして、リアルタイムで更新できます。
たとえば、チャットでメッセージが送信されると、Indeedがイベントを公開します。アプリケーションはこのイベントを受信し、スレッドに新しいメッセージをすぐに表示できます。
イベントタイプにはconnection-metadata、heartbeat、message-update、new-message、realtime-connection-configがあります。詳細については、Indeed Real-time APIイベントを参照してください。
APIの手順
#1. Indeed Real-time APIを設定する
#Indeed Real-time APIを呼び出す前に、アプリケーションのドメインを信頼できるドメインとして追加するよう、Indeedの担当者に依頼してください。
2. 認証する
#Indeed以外のドメインからのリクエストを認証するには、認可コードグラントタイプ(3-legged OAuth)を使用します。
3. サーバー送信イベントをサブスクライブする
#サブスクライブするには、Indeed Real-time APIエンドポイントにGETリクエストを送信します。アクセストークンは、Bearerスキームを使用してAuthorizationヘッダーで渡します。
デフォルトでは、APIはすべてのイベントタイプをストリーミングします。一部のイベントタイプのみを取得するには、eventTypesクエリパラメーターにカンマ区切りのイベントタイプリストを指定します。
レスポンスコードは、リクエストが成功したかどうかを示します。
| レスポンス コード | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | 成功 | 成功したレスポンスには次のフィールドが含まれます。
| |||||||||||||||
401 | エラー | 認証が正しくありません。OAuthエラーのトラブルシューティングを参照してください。 | |||||||||||||||
関連項目
#ガイド
#- 認可コードグラントタイプ(3-legged OAuth) — Indeedユーザーアカウントおよび関連付けられた採用企業アカウントに代わって動作するようにアプリを認可します。
- Indeed Real-time APIイベント — Indeed Real-time APIがストリーミングするイベントの一覧です。
- OAuthエラーのトラブルシューティング — Indeed APIにアクセスする前に発生するOAuthエラーの修正方法を説明します。
REST APIリファレンス
#- リアルタイム更新をストリーミング — サブスクライブしているアプリケーションにサーバー送信イベントをストリーミングします。