採用一括かんりくんAPI
API docs by Redocly

採用一括かんりくんAPI（中途版） v1 (1.0)

本リファレンスは中途版向けのものです。
新卒版はこちらです。

はじめに

採用一括かんりくんAPIとは

採用一括かんりくんAPIを使うことで、かんりくんの各種データの取得・更新ができます。 こちらのドキュメントで、APIの使い方をご確認ください。

事前準備

かんりくんの「各種設定」にてAPIの利用設定を行います。

  1. 「各種設定」>「外部公開API設定」を開く。
  2. 必要な情報を入力し、登録ボタンを押す。
  3. クライアントID、クライアントシークレットが表示されます。

認証

API実行にはアクセストークンが必要です。
アクセストークンは事前準備で取得した情報を用いて発行します。
詳しくは アクセストークン 発行 を確認してください。
発行したアクセストークンは、API実行時にHTTPヘッダー（X-KANRIKUN-TOKEN）にセットして使用します。

リクエスト制限

※制限については検証により変更の可能性があるため、予定のものを記載しています。

制限名称 説明
アクセストークンの有効期限 1時間
アクセストークンの最大同時払い出し数 1社につき60分毎に1000回まで
リクエスト制限 1社につき1時間で最大1000回のリクエスト

通信条件

条件 値
プロトコル HTTPS
メソッド POST

ベースURI

ベースURIは、https://api.career-cloud.asia/ です。
ベースURIの末尾に機能毎のURIを追加して記述してください。

（例）学生情報取得を利用する場合
    https://api.career-cloud.asia/mid-career/v1.0/candidate/get

レスポンスステータス

ステータスコード 内容 説明
200 正常
400 入力値エラー 変数名を含め入力値を再度確認してください。詳細はエラーメッセージをご確認ください。
401 認証エラー アクセストークンの有効期限が切れている、またはclient_id,client_secretの組み合わせが不正です。
403 認証エラー 権限が不足しています。新卒・中途でアクセストークンを取り違えていないか確認してください。
404 存在しないAPIを指定
409 データの競合 登録済みの候補者もしくは重複している可能性がある候補者が送信されています
429 リクエスト制限の超過 リクエスト制限超過。時間をおいて再度確認してください。
500 サーバーで予期せぬエラーが発生しました サーバーエラー。表示された場合はお問い合わせください。
503 システムメンテナンス中です 時間をおいてお試しください。
504 タイムアウトエラー

各種コード

取得項目

候補者情報取得で取得したい情報を指定する際に使用するコード

項目名 キー
姓 sei_kanji
名 mei_kanji
セイ sei_kana
メイ mei_kana
生年月日 birthday
電話番号1 mobile_number
電話番号2 phone_number
メールアドレス1 pc_email
メールアドレス2 mobile_email
性別 gender
郵便番号上3桁 postal_first
郵便番号下4桁 postal_last
住所詳細 address
配偶者 spouse
扶養家族 dependent_family
自己PR self_pr
志望理由 hope_occupations
職歴 employment_history
職歴備考 career_remarks
保有スキル skill
言語 language
保有資格 qualification
最終学歴 educational_background
希望年収 desired_salary
希望転職時期 desired_job_change_date
希望勤務地 desired_work_region
その他希望条件 other_desired_conditions
就活・転職状況 job_change_status
顔写真 face_photo
エントリーフォーム自由追加項目 ef_items
候補者情報追加項目 additional_items
エントリー日 entry_date
求人 job_id
エントリー経路 entry_root_id

都道府県コード

都道府県を指定する際に使用するID

ID 都道府県
01 北海道
02 青森県
03 岩手県
04 宮城県
05 秋田県
06 山形県
07 福島県
08 茨城県
09 栃木県
10 群馬県
11 埼玉県
12 千葉県
13 東京都
14 神奈川県
15 新潟県
16 富山県
17 石川県
18 福井県
19 山梨県
20 長野県
21 岐阜県
22 静岡県
23 愛知県
24 三重県
25 滋賀県
26 京都府
27 大阪府
28 兵庫県
29 奈良県
30 和歌山県
31 鳥取県
32 島根県
33 岡山県
34 広島県
35 山口県
36 徳島県
37 香川県
38 愛媛県
39 高知県
40 福岡県
41 佐賀県
42 長崎県
43 熊本県
44 大分県
45 宮崎県
46 鹿児島県
47 沖縄県

性別コード

性別を指定する際に使用するID

ID 性別
1 男性
2 女性
3 その他

選考ステータスコード

選考ステータスを指定する際に使用するID

ID 選考ステータス
1 選考前
2 選考中
4 採用決定
5 選考辞退
8 不合格

最終学歴ステータスコード

最終学歴のステータスを指定する際に使用するID

ID 選考ステータス
1 卒業
2 卒業見込
3 修了
4 修了見込
5 単位取得退学(満期退学)
6 単位取得退学(満期退学見込)
7 在学中
8 休学中
9 退学
10 退学見込
11 除籍

アクセストークン

アクセストークン 発行

アクセストークンを発行します。

Request Body schema: application/json
client_id
required
string

クライアントID

client_secret
required
string

クライアントシークレット

Responses

Request samples

Content type
application/json
{
  • "client_id": "71b556e6e7f993ed6db108bcf1fb6e84",
  • "client_secret": "986629d50d96ec47fbd6fe4f9dc05178ca25344c"
}

Response samples

Content type
application/json
{
  • "access_token": "e96034f183b3d9fa7036ca84af03ebcad77ded0a25101fb3ca2afb94db0ab71a-98657d018b663c703edb98a245dcf6aaf1ca1a7891b4171fb61f932db4e45fdcbc30e04dae602f42305761a0bebd7af7-988895b9d76651522592e6847bfa0ed02244a7e3367555b04cd64b8e5be1819dfc0e39bf7b8744d9c316b1c4d429c03594e7a49331561b385acefd250d260b87",
  • "expire_in": 1669598319
}

候補者情報

候補者情報取得

かんりくんに登録されている候補者の情報を取得することができます。

header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Request Body schema: application/json
object

検索条件

request
required
Array of strings

取得したい情報（詳細は各種コード 取得項目を参照）

page
integer
Default: 1

取得するページ番号。（指定なし:1）

size
integer [ 1 .. 100 ]
Default: 10

1ページごとの候補者数。（指定なし:10, 上限:100, 下限:1）

Responses

Request samples

Content type
application/json
{
  • "search": {
    },
  • "request": [
    ],
  • "page": 1,
  • "size": 10
}

Response samples

Content type
application/json
[
  • {
    }
]

候補者登録

かんりくんに候補者を登録することができます。
送信された値に問題がある場合はレスポンスデータのerrorsにエラー内容が出力されます。

{
  candidate_id: null,
  errors: [
    "日付の形式に誤りがあります"
  ] 
}

候補者が重複した際の挙動

メールアドレスまたは電話番号が一致する候補者がすでにかんりくん内に存在した場合、エラーを返します。
（返されるエラーの詳細については下部の「Responses」をご確認ください）
ただし、以下の情報については先にかんりくんに登録されている候補者に付与されます。
・エントリー経路
・求人
header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Request Body schema: application/json
sei_kanji
required
string

姓

mei_kanji
string

名

sei_kana
string

セイ

mei_kana
string

メイ

birthday
string

生年月日

mobile_number
string

電話番号1

phone_number
string

電話番号2

pc_email
string

メールアドレス1
メールアドレス1、メールアドレス2のいずれか必須

mobile_email
string

メールアドレス2
メールアドレス1、メールアドレス2のいずれか必須

gender
integer

性別（値は性別コードを参照）

postal_first
string

郵便番号上3桁

postal_last
string

郵便番号下4桁

address
string

住所詳細

spouse
string

配偶者

dependent_family
integer

扶養家族人数

self_pr
string

自己PR

hope_occupations
string

志望理由

Array of objects

職歴

career_remarks
string

職歴備考

skill
string

保有スキル

language
string

言語

qualification
string

保有資格

object

最終学歴

desired_salary
string

希望年収

desired_job_change_date
string

希望転職時期

desired_work_region
string

希望勤務地

other_desired_conditions
string

その他希望条件

job_change_status
string

就活・転職状況

remarks
string

備考

object

顔写真

Array of objects

エントリーフォーム自由追加項目
チェックボックスの項目の場合はvalに選択肢の配列を指定してください。

{
  "id": 13,
  "val": ["選択肢1", "選択肢2"]
}

ファイルアップロードの項目の場合はvalにファイル名とbase64エンコードされたファイルのデータを指定してください。

{
  "id": 13,
  "val": {
    "file_name": "xxxxx.pdf",
    "file_data": "0M8R4KGxGuEAAAAAAAAAAAAAA(略)"
  }
}
Array of objects

候補者情報追加項目
チェックボックスの項目の場合はvalに選択肢の配列を指定してください。

{
  "id": 13,
  "val": ["選択肢1", "選択肢2"]
}
entry_date
string

エントリー日

job_id
integer

求人

entry_root_id
integer

エントリー経路

Responses

Request samples

Content type
application/json
{
  • "sei_kanji": "採用",
  • "mei_kanji": "太郎",
  • "sei_kana": "サイヨウ",
  • "mei_kana": "タロウ",
  • "birthday": "0000-00-00",
  • "mobile_number": "09000000000",
  • "phone_number": "09000000000",
  • "pc_email": "sample@pc.example.com",
  • "mobile_email": "sample@mobile.example.com",
  • "gender": 1,
  • "postal_first": "101",
  • "postal_last": "0051",
  • "address": "東京都千代田区神田神保町2-5-3",
  • "spouse": "あり",
  • "dependent_family": 1,
  • "self_pr": "困難な状況下でも諦めずに、粘り強く一つ一つの物事を進めていくことを信条としています。",
  • "hope_occupations": "貴社の理念に深く共感し惹かれ志望致しました。",
  • "employment_history": [
    ],
  • "career_remarks": "人事担当者3名で採用人数100名を達成しました。",
  • "skill": "Word、Excel",
  • "language": "英語：ネイティブレベル",
  • "qualification": "情報処理検定1級",
  • "final_education": {
    },
  • "desired_salary": "500万円",
  • "desired_job_change_date": "3ヵ月以内",
  • "desired_work_region": "東京都",
  • "other_desired_conditions": "フルリモート勤務",
  • "job_change_status": "現職中",
  • "remarks": "転勤可能",
  • "face_photo": {
    },
  • "ef_items": [
    ],
  • "additional_items": [
    ],
  • "entry_date": "2022-04-03",
  • "job_id": 1,
  • "entry_root_id": 1
}

Response samples

Content type
application/json
{
  • "candidate_id": "10",
  • "errors": [ ]
}

項目取得

エントリーフォーム自由追加項目

エントリーフォーム自由追加項目を取得します

header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Responses

Response samples

Content type
application/json
{
  • "ef_item": [
    ]
}

候補者情報追加項目

候補者情報追加項目を取得します

header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Responses

Response samples

Content type
application/json
{
  • "additional_item": [
    ]
}

エントリー経路

エントリー経路を取得します

header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Responses

Response samples

Content type
application/json
{
  • "entry_root": [
    ]
}

求人

求人を取得します

header Parameters
X-KANRIKUN-TOKEN
required
string

アクセストークン

Responses

Response samples

Content type
application/json
{
  • "job": [
    ]
}