※ 本記事はfreee勤怠管理Plusについてのヘルプページです。freee人事労務については「freee人事労務のカテゴリー」をご覧ください。
freee勤怠管理Plus WebAPIサービスとの連携トークンを発行、管理できます。
※本機能は無料でご利用いただけます。
確認事項
「外部サービス連携(WebAPIなど)」から連携したいサービスのヘルプページを確認し、連携設定が完了していることをご確認ください。
WebAPI連携仕様
-
WebAPI利用禁止時間帯について
- 以下の時間帯(JST)はアクセストークン、打刻登録以外のAPIの利用ができません。
- 8:30~10:00
- 17:30~18:30
- 以下の時間帯(JST)はアクセストークン、打刻登録以外のAPIの利用ができません。
-
企業単位のWebAPIのレート制限について
- 本システムでは企業単位で次のレート制限を実施しています。
- これらのレートを超過した場合は「リクエスト数の上限に達しています」というエラーが返されます。
| 対象エンドポイント | レート |
|---|---|
|
トークンエンドポイント、日別打刻データ(POST) 以外のすべて ※すべてのAPIリクエストを合算して対象とします。 |
500リクエスト / 5分 |
|
日別打刻データ(POST) ※単体制限です。 |
2,000リクエスト / 5分 |
-
WebAPIに関するお問い合わせについて
- WebAPIを利用する際のお問い合わせは「API利用時のエラー」についてだけ受け付けております。
- 「○○サービスと連携できますか?」、「返ってくる値は何ですか?」などのお問い合わせにはお答えできません。
- トークン発行や「freee勤怠管理Plus WebAPI連携設定機能」に関するお問い合わせは、受け付けております。
初回設定
※admin全権管理者および全権管理者だけが可能な操作です。
- 設定 > その他 > オプション > 外部サービス連携カテゴリ > freee勤怠管理Plus WebAPI連携設定で、使用するを選択し、[登録]をクリックします。
- 設定反映のため、一度管理画面からログアウトし、再度ログインし直します。
- 設定 > その他 > オプション > 外部サービス連携カテゴリ > freee勤怠管理Plus WebAPI連携設定の[連携設定]をクリックします。
- 利用規約と同意書が表示されます。確認のうえ、問題なければ「確認のうえ、同意します。」にチェックを入れ、[承諾する]をクリックします。
※同意後は再表示されません。
新規アクセストークン発行
※admin全権管理者および全権管理者だけが可能な操作です。
- 設定 > その他 > オプション > 外部サービス連携カテゴリ > freee勤怠管理Plus WebAPI連携設定の[連携設定] > [+新規アクセストークン発行]をクリックします。
-
必要項目を入力して登録します。
【基本情報】項目名 説明 用途(必須) 用途を入力します。
※登録後も変更可能です。発行手段 「freee勤怠管理Plus WebAPI連携設定」と表示されます。 アクセストークン 新規登録時は空白です。 【API権限情報】
連携希望項目の「Read」、「Write」にチェックを入れます。
項目名 説明 Read 読み取り Write 書き取り 【許可IPアドレス】
番号 項目名 説明 ①
IPアドレス WebAPI接続元のグローバルIPアドレスを設定します。
ポート番号は設定不要です。※入力必須項目です。
②
サブネットマスク IPアドレスを範囲指定する場合は、サブネットマスクを設定します。サブネットマスク「32」は設定不要です。 ③
IPアドレス追加 IPアドレスを複数登録する場合はこちらをクリックします。
100個まで登録できます。
-
登録が完了すると、一覧に表示されます。
[編集]をクリックすると、アクセストークンを確認できます。「freee勤怠管理Plus WebAPI連携設定機能」で登録できるアクセストークンは20個までです。
freee勤怠管理Plus WebAPI連携設定 一覧画面
利用中のアクセストークンが一覧表示されます。
※「編集」項目が目のマークになっているものは編集できません。閲覧のみ可能です。操作制限の詳細は本ページの「操作権限」をご参照ください。
発行手段について
freee勤怠管理Plus WebAPI連携設定
「freee勤怠管理Plus WebAPI連携設定」機能で発行したトークンです。
操作権限
アクセストークン情報の閲覧および編集権限は以下の通りです。
| 発行手段 | アクセス |
API権限 |
許可IP 閲覧 |
編集 | 削除 | 管理者権限 |
|---|---|---|---|---|---|---|
| freee勤怠管理Plus WebAPI連携設定 | ◯ | ◯ | ◯ | ◯ | ◯ |
|