Kinmu Public API
Kinmuの勤怠データを、給与計算ソフト、入退室管理システム、BIツールと連携。 バージョン管理されたREST API、企業単位のAPIキー、明示的なスコープ、署名付きWebhookを備えています。
curl https://api.kinmu.app/v1/organization \
-H "Authorization: Bearer $KINMU_API_KEY"現在、このページ以外のドキュメントは英語で提供しています。
はじめに
アドオンを有効化し、キーを作成して、約5分で最初のAPIコールを実行できます。
Quickstartスコープ、キーのローテーション、サンドボックス、セキュリティのベストプラクティス。
認証とAPIキーページネーション、エラー、冪等性、レート制限。
API規約9つのリソースを確認し、各エンドポイントを試せます。
インタラクティブリファレンスユースケース別の連携
実労働時間・欠勤・休暇残高を給与計算サイクルに取り込みます。
給与計算ゲート・カード・キオスクからの打刻を POST /v1/check-ins で登録します。
ポーリングによる増分同期でダッシュボードを更新します。
BI / Power BIv1で提供するリソース
v1では https://api.kinmu.app/v1 配下に 9つのRESTリソースを提供しています。
| リソース | 用途 |
|---|---|
| Organization | APIキーと企業情報のイントロスペクション。 |
| Employees | 従業員の登録・更新・退職処理。 |
| Check-ins | 打刻イベント（in / out / break）と打刻元の記録。 |
| Work summaries | 給与計算向けの勤務時間集計。 |
| Absences | 欠勤・休暇の申請、承認、却下。 |
| Vacation balances | 従業員・年度ごとの休暇残高。 |
| Locations / Units | 組織構造（読み取り専用）。 |
| Reports | 非同期レポート（法定勤怠記録、エクスポート）。 |
| Webhooks | 署名付きのアウトバウンドイベント（Standard Webhooks）。 |
企業は常にAPIキーから解決されます。公開ルートやリクエストボディに {companyId} が現れることはありません。
設計原則
- 凍結されたコントラクト。 v1に入ったものは互換性を壊す形では変更されません。廃止はchangelogで12か月前に告知されます。
- 最小権限。 すべてのキーは明示的なスコープを持ち、スコープがなければアクセスできません（
403 invalid_scope）。 - 完全な監査。 企業キーによるすべてのリクエストは
origin=public_apiとして記録されます。 - アプリと同じルール。 API経由の書き込みも、アプリケーションと同じドメインバリデーションを通ります。
さらに詳しく
Last updated on