概要
この記事では、HRMOSタレントマネジメントにおけるAPI機能の概要、および利用する際に必要な初期設定について説明します。
目次
・HRMOSのAPIの概要
・API利用時に必要な初期設定
・サポート範囲について
・よくあるご質問
HRMOS APIの概要
HRMOS タレントマネジメントでは2種類のAPIをご用意しています。
1.SCIM 2.0 for CORE API
SCIMに則った仕様です。
エンドポイント：https://core.hrmos.co/api/scim/v2
2.HRMOS CORE API
HRMOSCORE APIでは、以下に対応しています。
・従業員アカウントの作成、削除
・従業員情報の取得、更新、削除（従業員1人×1セクション）
・会社マスタの取得
・部署情報のカスタム項目の取得、更新
エンドポイント：https://core.hrmos.co/api/v3
API利用時に必要な初期設定
APIを利用する際に必要な初期設定には、以下の3つのステップがあります。
【1】Admin権限グループを作成する
【2】社員情報・部署情報の権限を設定する
【3】トークンを作成する
【1】Admin権限グループを作成する
APIで行える操作は、設定したAdmin権限グループにおいて付与している権限に基づきます。
例えば、APIを利用して、社員登録や削除をする場合は、社員の操作の権限の「登録」「削除」にチェックを入れてください。
社員情報の取得や更新のみであれば、チェックは入れずに右下の「保存」をしてください。
権限グループの作成方法の詳細は、＜Admin（管理画面）の権限設定＞をご確認ください。
【2】社員情報・部署情報の権限を設定する
上記＜権限グループの作成＞にて作成したAdminグループに対し、取得・更新をされたい社員情報や部署情報に閲覧・編集権限を付与します。
権限の設定方法は＜Admin（管理画面）の権限設定＞をご参照ください。
【注意点】
・適用日を指定して、社員情報の取得や更新をする場合は、履歴データに対する閲覧権限、ないし編集権限を設定してください。
・SCIM 2.0 for CORE APIを利用する場合は、必ず「アカウント > 基本情報 > 認証メールアドレス」に閲覧・編集権限を設定してください。
※編集する必要がなければ「閲覧」にしていただくことをおすすめいたします。
【3】トークンを作成する
1.Admin（管理画面）にて、「会社」タブ ＞「Adminの設定」＞「API」を開き、画面右上の「＋」 をクリックします。2.「トークンの名称」に任意のトークン名を入力します。「権限」は＜権限グループの作成＞にて作成したグループを選択します。右下の「保存」をクリックすると登録が完了します。
※必要に応じて「トークンの説明」「有効期限」も入力してください。
登録が成功すると、トークン文字列が発行されます。
APIを利用する際の認証に用いるため、厳重に保管をお願いいたします。
万が一、トークン文字列が漏洩した際は、トークンをすぐに削除してください。
サポート範囲について
API機能は下記のポリシーに即して提供しております。
弊社からソースコードの提供はしておりません。
「HRMOS APIの概要」に記載しているリファレンスをご参照ください。
※本記事に記載している初期設定の完了後、個別の操作・設定については、原則として個別のサポートをしておりません。
API機能のよくあるご質問
Q. 部署情報の一覧が取得できません。
A. 権限グループへ「アカウント > 基本情報 > 認証メールアドレス」の閲覧権限が付与されていない可能性があります。
権限の設定方法は＜こちら＞をご参照ください。
Q. Webhook機能は利用できますか？
A.ご利用いただけます。
詳細は、記事：カスタム通知の設定方法よりご確認ください。
Q. 従業員情報の取得ができません。
A. Admin権限グループに付与している権限が不足している可能性があります。再度権限設定をご確認ください。
※適用日を設定している場合は、「履歴」データに対する閲覧ないし編集権限が必要です。権限の設定方法は＜こちら＞をご参照ください。