はじめまして。SmartHR 開発チームの芹澤です。
これまで SmartHR では開発者向けの機能として従業員情報の参照系 API を提供させていただいていましたが、この度、ご要望の多かった更新系のエンドポイントを追加いたしました！
利用シーン
従業員情報の更新系 API を使うことで、SmartHR の画面を操作せずに従業員の追加や更新が行えます。 例えば、従業員情報を扱う各種ツールが API や Webhook を持つ場合、以下のような連携が可能となります。
- 採用管理ツール
- 例: 入社が決まった内定者の情報を API 経由で SmartHR に追加
- 従業員管理ツール
- 例: ツール上での従業員情報の更新を Webhook で受け取り、リアルタイムで SmartHR に反映
また、SmartHR では従業員情報の一括変更の手段として CSV・エクセルのインポート機能を提供させていただいていますが、更新系 API を使うことでよりプログラマブルな一括変更が可能となります。
更新系 API のエンドポイント
更新系 API のエンドポイントには以下の4つをご用意しています。
- POST /crews
- 従業員情報を追加します
- PUT /crews/:id
- 従業員情報を更新します
- PATCH /crews/:id
- 従業員情報を部分更新します
- DELETE /crews/:id
- 従業員情報を削除します
REST に沿った作りで、直感的にご利用いただけるようになっています。 インターフェース仕様の詳細についてはこちらをご参照ください。
備考
- SmartHR 画面上からの操作同様、API 経由での従業員の追加・更新・削除時でも以下の処理が行われます
- 監査ログの記録
- Webhook の発動（Webhook 設定時のみ）
- SmartHR をまだご利用いただいていない方でも API をテストしていただけるよう、サンドボックス環境をご用意しております。詳しくはこちらをご参照ください
各種ご要望について
SmartHR API はまだまだ公開後間もないサービスです。ご利用にあたり、機能の不足や使いづらさを感じられるかもしれません。私たちは、ユーザー様のご意見をもとに SmartHR API をより良くしていこうと思っております。機能の要望などございましたら、仕様書ページのチャットアイコンよりお気軽にご連絡いただけますと幸いです。
また、SmartHR API を使った各種サービス連携も積極的に承っております。 サービス連携をご検討されているサービス運営者様につきましても、チャット等でご連絡いただければと思います。
さいごに
SmartHR ではテクノロジーを駆使して社会構造を Hack したいエンジニアを募集しています。 ご興味を持っていただけましたら、ぜひ以下のボタンよりご応募くださいませ。
引き続き、SmartHR をよろしくお願いいたします。
