SmartHR APIに関するよくある質問

Q. SmartHR APIの使い方を教えてください

A. 「APIリファレンス」をご活用ください

利用方法は、SmartHR APIの仕様についてのドキュメントAPI リファレンスで案内しています。 実際のリクエストを試したい場合は、以下の手順に沿って操作してください。

1. APIリファレンスの［サブドメイン・アクセストークンを設定する］を押し、サブドメイン・アクセストークンを設定します。
2. 使用したいAPIの折りたたみメニューを開きます。
3. ［Parameters］の［Try it out］を押し、各パラメーターの値を指定します。
4. ［Execute］を押すと、指定したパラメーターの値でリクエストが送信され、［Responses］にレスポンスが表示されます。

サブドメインおよびアクセストークンの発行方法は、以下のヘルプページを参照してください。

Q. 画像URLの有効期限はありますか？

A. あります

180秒で無効になるため、有効期限が切れたものは再取得するか、ダウンロードし直してください。

Q. 部署コードはどこを設定すれば良いですか？

A. 部署マスターの追加・編集画面で設定できます

詳しくは部署マスターとはを参照してください。

Q. 従業員情報の「id」「user_id」「emp_code」とは何ですか？

A. 以下のとおりです

• id
  • 企業アカウント内で一意な、従業員情報のIDです。
  • 従業員情報を登録すると自動で発行されます。
• user_id
  • 企業アカウント内で一意な、アカウントのIDです。
  • 招待や社員番号アカウントの作成を行なうと、自動で発行されます。
  • 従業員がSmartHRにログイン済みで、各自パスワードを設定している状態のアカウントです。
  • 従業員情報のみ登録され、アカウントの発行がされていない場合は「null」になります。
• emp_code
  • 社員番号です。
  • 従業員情報で変更できます。

Q. ドロップダウンリストタイプのカスタム従業員項目に、APIを使用して情報を登録・更新できますか？

A. はい、要素IDまたは物理名を指定すればできます

APIで従業員情報を操作する際、入力タイプがドロップダウンリストのカスタム従業員項目の情報を登録・更新するには、ドロップダウンリストの要素IDまたは物理名を指定してください。

物理名は、カスタム従業員項目の編集画面から登録できます。 詳しくは、【一覧】[入力タイプ] ごとのカスタム従業員項目の表示 の「ドロップダウンリスト」を参照してください。 カスタム従業員項目の設定方法は、カスタム従業員項目とはを参照してください。

画像を表示する