画面の検索条件をAPIで使う
企業検索・求人検索で設定した条件は、検索画面からREST API用のcURLへ変換できます。画面で検索結果を確認してから、自社システムやスクリプトへ移すときに利用します。
cURLを生成する
- 企業検索または求人検索で条件を設定します
- 画面上部の「API」を押します
- エンドポイントとリクエスト本文を確認します
- 「コピー」を押します
- APIキーと認証に従ってAPIキーを環境変数に設定し、リクエストへ付けます
企業検索には POST /companies/search、求人検索には POST /jobs/search を使います。送信先は https://api.salesbrain.jp/rest/v1 です。コピーしたコマンドも、このURLと最新のリクエスト形式になっていることを確認してください。
cURLに反映されるもの
- 現在設定している企業・求人フィルター
- 1回の取得件数
limit - 取得開始位置
offset Content-Type: application/jsonX-API-Key: <your-api-key>
API v4.0.0では、検索条件を filter.company と filter.job に分けます。条件グループは filter.filterGroups に指定し、項目やグループを結ぶAND・ORは combination で指定します。limit、offset、includeTotalResults はリクエストのトップレベルに入ります。
コピーしたコマンドの X-API-Key: <your-api-key> ヘッダーは、APIキーの環境変数を使う方法へ変更してください。企業検索API・求人検索APIの例では、キーをcURLのコマンド引数に含めず、標準入力から渡しています。
画面上の並び順と「列の表示」はcURLに反映されません。必要な場合は、APIの仕様に沿ってリクエストまたは取得後の処理へ追加してください。
APIキーを準備する
APIキーの作成手順はAPIキーと認証を参照してください。APIの項目定義は、WebアプリのAPIドキュメント ↗で確認できます。
APIキーをソースコード、チャット、公開リポジトリへ貼り付けないでください。環境変数やシークレット管理機能へ保存します。
期待した結果にならない場合
- 同じ条件でWebアプリの検索結果を確認します
- マスター選択項目は、APIへ送られるIDを確認します
limitとoffsetが想定したページになっているか確認します- APIキーが有効か確認します
- レスポンスのHTTPステータスとエラー本文を確認します
- 旧形式の検索条件を使っている場合は、API仕様変更のお知らせと最新のAPIガイドを確認して更新します