採用一括かんりくん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/new-graduate/v1.0/student/get

レスポンスステータス

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

各種コード

取得項目

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

項目名 キー
姓 sei_kanji
名 mei_kanji
セイ sei_kana
メイ mei_kana
学校名 school_name
学部 gakubu
学科 gakka
生年月日 birthday
携帯番号 mobile_number
PCメールアドレス pc_email
携帯メールアドレス mobile_email
性別 gender
現住所郵便番号上3桁 current_postal_first
現住所郵便番号下4桁 current_postal_last
現住所都道府県 current_prefecture
現住所詳細 current_address
現住所電話番号 current_phone_number
休暇中の連絡先郵便番号上3桁 home_postal_first
休暇中の連絡先郵便番号下4桁 home_postal_last
休暇中の連絡先都道府県 home_prefecture
休暇中の連絡先住所詳細 home_address
休暇中の連絡先電話番号 home_phone_number
卒業予定時期 graduate
ゼミ、研究室名 semi_labo
クラブ、サークル名 club_circle
専攻テーマ major_title
文理区分 bunri
希望職種 hope_occupations
資格・スキル qualification_skill
応募しようと思ったきっかけ opportunity
長所・短所 features
趣味や興味のあること hobby
ポリシーやこだわり policy
過去の実績・制作物 portfolio
その他アピールポイント appeal
顔写真 face_photo
エントリーフォーム自由追加項目 ef_items
学生情報追加項目 additional_items
エントリー日 entry_date
エントリー経路 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 理系
3 その他

選考ステータスコード

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

ID 選考ステータス
1 選考前
2 選考中
3 内定
4 内定承諾
5 選考辞退
6 内定承諾前辞退
7 内定承諾後辞退
8 不合格

アクセストークン

アクセストークン 発行

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

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
{
  • "students": [
    ]
}

学生登録

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

{
  student_id: null,
  errors: [
    "日付の形式に誤りがあります"
  ] 
}
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

メイ

school_name
string

学校名

gakubu
string

学部

gakka
string

学科

birthday
string

生年月日

mobile_number
string

携帯電話番号

pc_email
string

PCメールアドレス
PCメールアドレス、携帯メールアドレスのいずれか必須

mobile_email
string

携帯メールアドレス
PCメールアドレス、携帯メールアドレスのいずれか必須

gender
integer

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

current_postal_first
string

現住所郵便番号上3桁

current_postal_last
string

現住所郵便番号下4桁

current_prefecture
string

現住所都道府県（値は都道府県コードを参照）

current_address
string

現住所詳細

current_phone_number
string

現住所電話番号

home_postal_first
string

休暇中の連絡先郵便番号上3桁

home_postal_last
string

休暇中の連絡先郵便番号下4桁

home_prefecture
string

休暇中の連絡先都道府県（値は都道府県コードを参照）

home_address
string

休暇中の連絡先住所詳細

home_phone_number
string

休暇中の連絡先電話番号

graduate
string

卒業予定時期

semi_labo
string

ゼミ、研究室名

club_circle
string

クラブ、サークル名

major_title
string

専攻テーマ

bunri
string

文理区分（値は文理区分コードを参照）

hope_occupations
string

希望職種

qualification_skill
string

資格・スキル

opportunity
string

応募しようと思ったきっかけ

features
string

長所・短所

hobby
string

趣味や興味のあること

policy
string

ポリシーやこだわり

portfolio
string

過去の実績・制作物

appeal
string

その他アピールポイント

object

顔写真

Array of objects

資料(履歴書など)
ファイル名とbase64エンコードされたファイルのデータを指定してください。

{
  "file_name": "xxxxx.pdf",
  "file_data": "ffd8ffe000104a46494600010(略)"
}
Array of objects

学生に関連するurl

{
  "url_title": "urlタイトル",
  "url": "url"
}
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

エントリー日

entry_root_id
integer

エントリー経路

Responses

Request samples

Content type
application/json
{
  • "sei_kanji": "採用",
  • "mei_kanji": "太郎",
  • "sei_kana": "サイヨウ",
  • "mei_kana": "タロウ",
  • "school_name": "採用大学",
  • "gakubu": "情報学部",
  • "gakka": "情報学科",
  • "birthday": "0000-00-00",
  • "mobile_number": "09000000000",
  • "pc_email": "sample@pc.example.com",
  • "mobile_email": "sample@mobile.example.com",
  • "gender": 1,
  • "current_postal_first": "101",
  • "current_postal_last": "0051",
  • "current_prefecture": "13",
  • "current_address": "千代田区神田神保町2-5-3",
  • "current_phone_number": "0300000000",
  • "home_postal_first": "163",
  • "home_postal_last": "8001",
  • "home_prefecture": "13",
  • "home_address": "新宿区西新宿2-8",
  • "home_phone_number": "0300000000",
  • "graduate": "2024年3月",
  • "semi_labo": "IT研究室",
  • "club_circle": "情報処理研究会",
  • "major_title": "AI技術の活用について",
  • "bunri": "2",
  • "hope_occupations": "システムエンジニア",
  • "qualification_skill": "情報処理検定1級",
  • "opportunity": "IT技術レベルの高さに魅力を感じたため",
  • "features": "問題解決能力",
  • "hobby": "趣味は映画、舞台鑑賞です。",
  • "policy": "知識の無い分野でも積極的に取り組む",
  • "portfolio": "競技プログラミングコンテストの予選通過",
  • "appeal": "積極性を発揮して活躍したいと思います。",
  • "face_photo": {
    },
  • "es_files": [
    ],
  • "student_links": [
    ],
  • "ef_items": [
    ],
  • "additional_items": [
    ],
  • "entry_date": "2022-04-03",
  • "entry_root_id": 1
}

Response samples

Content type
application/json
{
  • "student_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": [
    ]
}