●APIについて

TalentioではHTTPSを用いたAPIによる候補者情報の取得が可能です。
この機能により任意のフォーマットに整形して候補者情報を管理したり、分析したりすることが可能となります。

●アクセストークンの設定

APIを利用するには「グローバル設定」より「API設定」画面を開きます。
ここでアクセストークンを発行することが出来ます。
発行されたトークンは忘れずにメモしておいてください。
ウィンドウを閉じるとトークンを確認することは出来ません

●アクセス制限

TalentioではAPIアクセスを1時間に1,000リクエストまでに制限しています。
APIのレスポンスヘッダーには以下のアクセス情報が付加されます。

X-REMAINING: 992 # 期間内にリクエストできる残りの回数
X-RESET: 1153    # 残り回数がリセットするまでの秒数

●認証

リクエストヘッダーに以下のようにアクセストークンを付加してください。

curl -H 'Authorization: Bearer ACCESS_TOKEN' https://talentio.com/api/v1


●レスポンスステータス

レスポンスのステータスコードは以下のように解釈されます。

ステータスコード:説明
200:正常なレスポンス
400:パラメーターに不備があった
401:認証に失敗した
429:アクセス回数が制限を超えた
500:サーバー側で予期しないエラーが発生した

●候補者一覧の取得

エンドポイント : https://talentio.com/api/v1/candidates
メソッド : GET

パラメータ:説明:デフォルト値
page :
取得するページ、1ページ内に含まれる候補者数は100です: 1
status : 候補者のステータスで絞りこみます : 設定なし
 status = ongoing # 選考中
 status = reject # 辞退
 status = fail # 不合格
 status = pass # 採用
 status = poolActive # コンタクト中
 status = poolInactive # 非コンタクト中
sort : ソート : 登録日もしくは応募日でソートすることが可能です
 sort = registeredAt #
登録日昇順
 sort = -registeredAt # 登録日降順
    sort = appliedAt # 応募日昇順
    sort = -appliedAt # 応募日降順

## jsonレスポンス
[{
  "id": 0,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "description": "string",
  "requisition": {
    "id": 0,
    "name": "string",
    "active": true
  },
  "registeredAt": "2016-08-04T13:59:13+09:00",
  "appliedAt": "2016-08-03T13:59:13+09:00",
  "joinedAt": "2016-10-01T0:00:00+09:00",
  "stages": [{
    "id": 0,
    "type": "resume",
    "step": 1,
    "status": "ongoing"
  }],
  "status": "ongoing",
  "channelType": "agentCompany",
  "agentCompany": {
    "id": 0,
    "name": "string"
  },
  "priority": 0,
  "tags": [{
    "id": 0,
    "name": "string"
  }],
  "customFields": [
    {
      "name": "multi line",
      "value": "string\nstring\nstring"
    },
    {
      "name": "single line",
      "value": "string"
    },
    {
      "name": "number",
      "value": 256
    },
    {
      "name": "date",
      "value": "2016-08-17T00:00:00+09:00"
    }
  ]
}]

また条件にマッチした候補者の総数はレスポンスのHTTPヘッダーに以下のように表示されます。

X-TOTAL: 100

●候補者詳細の取得

候補者リストには含まれない、選考の各評価などの情報を取得することが出来ます。

エンドポイント : https://talentio.com/api/v1/candidates/{id}
メソッド : GET

## jsonレスポンス
{
  "id": 0,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "requisition": {
    "id": 0,
    "name": "string",
    "active": true
  },
  "description": "string",
  "registeredAt": "2016-08-04T13:59:13+09:00",
  "appliedAt": "2016-08-03T13:59:13+09:00",
  "joinedAt": "2016-10-01T0:00:00+09:00",
  "stages": [{
    "id": 65891,
    "type": "contact",
    "step": 1,
    "scheduledAt": "2016-08-17T00:00:00+09:00",
    "status": "ongoing",
    "description": "string",
    "evaluations": [{
      "id": 0,
      "finished": false,
      "items": [{
        "name": "string",
        "type": "none"
      }],
      "employee": {
        "id": 1565,
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "active": true
      }
    }]
  }],
  "status": "poolActive",
  "channelType": "employee",
  "referrerEmployee": {
    "id": 0,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "active": true
  },
  "priority": 0,
  "tags": [
    "id": 0,
    "name": "string"
  ]
}

●選考の追加

指定した候補者に対して任意の種別の選考を追加します。

エンドポイント : https://talentio.com/api/v1/candidates/{id}/stages
メソッド : POST

パラメーター:説明 : デフォルト値
evaluations : 評価者を以下のフォーマットで設定します : 必須
 evaluations : [
                            {"employee" : "
aaa@bbb.ccc"},
                            {"employee" : "
ddd@eee.fff"}
                           ]

type : 選考種別を以下の文字列で設定します : 必須
 type = contact,resume,interview,reference,final
scheduledAt : 選考日をIOS8601形式で設定します : null
    schedulesAd = '2005-08-15T15:52:01+0000'
description : 補足を文字列として設定します : 空文字 

$ curl -i -H 'Authorization: Bearer [TOKEN]' -H 'Content-Type: application/json' https://talentio.com/api/v1/candidates/00000/stages -X POST -d '{"evaluations":[{"employee":"xxx@yyy.zzz"}], "type":"resume"}'
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json
Date: Mon, 22 May 2017 14:58:04 GMT
Server: Apache/2.4.18 (Ubuntu)
Vary: Authorization
X-REMAINING: 994
X-RESET: 2745
Content-Length: 13
Connection: keep-alive{"success":1}

●コメント一覧の取得

エンドポイント : https://talentio.com/api/v1/candidates/{id}/comments
メソッド : GET

## jsonレスポンス
[
  {
    "content": "string",
    "employeeCreatedBy": {
      "id": 0,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "active": true
    },
    "createdAt": "2017-05-19T19:51:41+09:00",
    "updatedAt": "2017-05-19T19:51:41+09:00"
  },
  ...
]

contentに含まれるメンションは以下のようなフォーマットで出力されます

"1st line\n${xxx@yyy.zzz}\n3rd line"

●コメントの追加

エンドポイント : https://talentio.com/api/v1/candidates/{id}/comments
メソッド : POST
パラメーター : content
説明 : "1st line\n${
xxx@yyy.zzz} \n3rd line"
デフォルト値 : 必須

$ curl -i -H 'Authorization: Bearer [TOKEN]' -H 'Content-Type: application/json' https://talentio.com/api/v1/candidates/00000/comments -X POST -d '{"content":"hoge${xxx@yyy.zzz}"}'
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json
Date: Mon, 22 May 2017 14:50:28 GMT
Server: Apache/2.4.18 (Ubuntu)
Vary: Authorization
X-REMAINING: 996
X-RESET: 3201
Content-Length: 13
Connection: keep-alive{"success":1}
回答が見つかりましたか?