いつもジンジャーをご利用いただきありがとうございます。
2025年12月23日(火)にジンジャーAPIの仕様変更および機能アップデートを実施しました。
詳細は以下のとおりです。
※仕様変更の内容はすでに【告知】として広報しています。
目次
機能アップデート
・1リクエストで取得できる勤怠の情報の拡張
・ワークフローの申請書URLを取得できる機能の追加
・APIで更新できる従業員情報を追加
・シフトデータ取得時の時刻項目の改善※追記
仕様変更
・振休代休データ取得時の返却内容を変更
ジンジャーAPIについて
機能アップデート
1リクエストで取得できる勤怠の情報の拡張
概要
ジンジャーAPIで取得(GET)できる情報を追加しました。
影響
取得(GET)できるようになった情報とAPIは下記のとおりです。
従業員ごとの取得(GET)はすでに公開済みでしたが、今回の機能アップデートにより、それぞれ複数の従業員の情報を一度のリクエストで取得できるようになりました。
情報 |
API |
|---|---|
| 勤怠管理者画面>予定と出勤 の各従業員の実績(打刻) | GET /v2/employees/attendances |
| 勤怠管理者画面>予定と出勤 の各従業員の予定(スケジュール) | GET /v2/employees/work-schedules |
| 勤怠管理者画面>申請承認>休日休暇承認 | GET /v2/employees/requested-day-offs |
| 勤怠管理者画面>申請承認>休日出勤(振)承認 勤怠管理者画面>申請承認>休日出勤(代)承認 |
GET /v2/employees/converted-day-offs |
| 勤怠管理者画面>データ出力>入退館・PCログデータ | GET /v2/employees/work-logs |
ワークフローの申請書URLを取得できる機能の追加
概要
ジンジャーAPIで取得(GET)できる情報を追加しました。
影響
取得(GET)できるようになった情報とAPIは下記のとおりです。
申請書の一覧および詳細の取得(GET)はすでに公開済みでしたが、今回の機能アップデートにより、申請書URLの情報も取得できるようになりました。
情報 |
API |
|---|---|
| 従業員画面>ワークフロー>申請データ一覧>申請書URL | GET /v1/workflow-requests |
| 従業員画面>ワークフロー>申請データ一覧>カスタム申請>申請書URL | GET /v1/workflow-requests/custom-requests/{id} |
| 従業員画面>ワークフロー>申請データ一覧>入社申請>申請書URL | GET /v1/workflow-requests/onboardings/{id} |
| 従業員画面>ワークフロー>申請データ一覧>異動申請(主務)>申請書URL | GET /v1/workflow-requests/affiliation-changes/{id} |
| 従業員画面>ワークフロー>申請データ一覧>異動申請(兼務)>申請書URL | GET /v1/workflow-requests/sub-affiliation-changes/{id} |
| 従業員画面>ワークフロー>申請データ一覧>退社申請>申請書URL | GET /v1/workflow-requests/offboardings/{id} |
| 従業員画面>ワークフロー>申請データ一覧>扶養変更申請>申請書URL | GET /v1/workflow-requests/dependent-changes/{id} |
APIで更新できる従業員情報を追加
概要
ジンジャーAPIで更新(PATCH)できる情報を追加しました。
影響
更新(PATCH)できるようになった情報とAPIは下記のとおりです。
従業員のログイン関連の取得(GET)はすでに公開済みでしたが、今回の機能アップデートにより、各従業員のログイン関連の設定(2段階認証の利用可否)の更新もできるようになりました。
ただし、企業設定で2段階認証の利用が有効ではない場合は、各従業員の2段階認証の利用は有効にできません。
情報 |
API |
|---|---|
| 従業員管理>ログイン関連 | PATCH /v1/employees/login-settings |
シフトデータ取得時の時刻項目の改善※追記
2025年12月26日に追記しました
概要
ジンジャーAPIで取得(GET)できる情報を改善しました。
影響
改善された情報とAPIは下記のとおりです。
従来、ジンジャー勤怠上のシフトに登録された異なる時刻(例. 06:00 と 30:00)が同じ値として返却されることがありましたが、今回の機能アップデートにより、ジンジャー勤怠上に登録された通りの時刻として返却されるようになりました。
情報 |
API |
|---|---|
| 勤怠管理者画面>予定と出勤 の各従業員の予定(スケジュール) | GET /v1/employees/work-schedules |
仕様変更
振休代休データ取得時の返却内容を変更
概要
振休代休データの取得(GET /v1/employees/converted-day-offs)でデータの重複を防ぐため、返却される内容を変更しました。
影響
本件の対象の情報とAPIは下記のとおりです。
情報 |
API |
|---|---|
| 勤怠管理者画面>申請承認>休日出勤(振)承認 勤怠管理者画面>申請承認>休日出勤(代)承認 |
GET /v1/employees/converted-day-offs |
変更前
振休代休データの返却内容として、以下が別のレコードとして返却されていました。
- 振休代休の発生(休日出勤などによって発生した振休代休の情報)とそのステータス
- 振休代休の利用(振休代休を利用して休暇を取得するための休日休暇申請の情報)とそのステータス
変更後
振休代休データの返却内容として、以下のみ返却されるようにしました。
- 振休代休の発生(休日出勤などによって発生した振休代休の情報)とそのステータス
背景
- 振休代休の発生と利用は同じ情報に属する要素であり、別のレコードとして返却されるべきではないため
- 振休代休の利用は休日休暇データの取得(GET /v1/employees/requested-day-offs)で返却され、別途取得できるため
ジンジャーAPIについて
ジンジャーAPIについての操作や、連携できる項目についてはこちら
ジンジャーAPIを利用するためのジンジャー上での設定についてはこちら
以上です。
皆さまのご要望に基づき、新機能開発、機能改善を進めてまいりますので、
引き続きよろしくお願いいたします。
【機能アップデートおよび仕様変更日時】
12月23日(火)22:00~12月24日(水)5:00