取得API連携

給与計算システムなどの外部システムから Work Handler のデータを取得するための「取得API連携」の説明です。

概要

取得API連携を使うと、給与計算システムなどの外部システムから Work Handler の勤怠データなどを取得できます。あなたが発行する「APIキー」で本人確認を行い、あなた自身が見られる範囲のデータだけを取得できます。取得（読み取り）専用で、データの変更はできません。

使いはじめる手順

ユーザー情報の編集画面のメニュー「取得 API キー」から、APIキーを発行します（自分の画面でのみ表示されます）。
発行するときに、キーの名前と有効期限（1か月／3か月／半年／1年／無期限）を決めます。
発行されたキーは、このとき一度だけ表示されます。あとから見直せないので、コピーして安全に保管してください。
連携先の外部システムに、接続先のベースURLとAPIキーを登録すると使えるようになります（登録の作業はご自身で行ってください）。

APIキーの管理

発行済みのキーは一覧で確認できます（名前・キーの一部・発行日時・最後に使った日時・有効期限・状態）。
状態は「有効」「失効」「期限切れ」のいずれかです。
使わなくなったキーは「失効」させられます。失効したキーは二度と使えません（必要なら新しく発行してください）。
同時に有効にできるキーは最大10個までです。MCP連携のキーとは別に管理されます。

取得できるもの

取得できるのは、あなた自身が見られる範囲に限られます。

所属している組織や受け取った招待、メンバーやグループ、タイムカードの内容・設定・集計、承認フローや承認経路、コメント、休日、各種の統計など。

注意点

取得（読み取り）専用です。データの作成・変更・削除はできません。
組織を指定する取得では、あなたが参加している組織のIDが必要です。
あなたが在籍していない組織のデータは取得できません。APIキーが有効でも、その組織に対する呼び出しは拒否されます（キー自体は有効なままで、ほかの組織では使えます）。
1つのAPIキーはあなた本人の権限で動きます。特定の組織だけに限定することはできません。
呼び出せる回数には上限があります。
組織でアクセス元のネットワーク制限を設定している場合、連携先システムの接続元がその範囲に含まれている必要があります。
もしAPIキーが他人に知られても、影響はあなたが見られる範囲の取得にとどまります。